afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/ActionLinkTemplate.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "usage",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "ActionLinkTemplate - Data API",
  "description": "Action link templates let you reuse action link definitions and package and distribute action links. An action link is a button on a feed element. Clicking an action link can take a user to another Web page, initiate a file download, or invoke an API call to an external server or Salesforce. Use action links to integrate Salesforce and third-party services into the feed. This object is available in API version 33.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "ActionLinkGroupTemplateId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "ID of the ActionLinkGroupTemplate with which this action link template is associated. This is a relationship field.",
      "relationship_name": "ActionLinkGroupTemplate",
      "relationship_type": "Lookup",
      "refers_to": "ActionLinkGroupTemplate"
    },
    "ActionUrl": {
      "type": "textarea",
      "properties": "Create, Update",
      "description": "The action link URL. For example, a Ui action link URL is a Web page. A Download action link URL is a link to the file to download. Ui and Download action link URLs are provided to clients. An Api or ApiAsync action link URL is a REST resource. Api and ApiAsync action link URLs aren’t provided to clients. Links to Salesforce can be relative. All other links must be absolute and start with https://.Links to resources hosted on Salesforce servers can be relative, starting with a /. All other links must be absolute and start with https://. This field can contain context variables and binding variables in the form {!Bindings.key}, for example, https://www.example.com/{!Bindings.itemId}. Set the binding variable’s value when you instantiate the action link group from the template."
    },
    "Headers": {
      "type": "textarea",
      "properties": "Create, Nillable, Update",
      "description": "Template for the HTTP headers sent when corresponding action links are invoked. This field can be used only for Api and ApiAsync action links. This field can contain context variables and binding variables in the form {!Bindings.key}."
    },
    "IsConfirmationRequired": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "If true, a confirmation dialog appears before the action is executed."
    },
    "IsGroupDefault": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "If true, action links derived from this template are the default or primary action in their action groups. There can be only one default action per action group."
    },
    "Label": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "A custom label to display on the action link button. If none of the LabelKey values make sense for an action link, use a custom label. Set the LabelKey field to None and enter a label name in the Label field. Action links have four states: new, pending, success, and failed. These strings are appended to the label for each state: Label Label Pending Label Success Label Failed For example, if the value of Label is “Call Home,” the values of the four action link states are: Call Home, Call Home Pending, Call Home Success, and Call Home Failed. If LabelKey has any value other than None, the Label field is empty."
    },
    "LabelKey": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "Key for the set of labels to display for these action link states: new, pending, success, failed. For example, the Approve set contains these labels: Approve, Pending, Approved, Failed. For a complete list of keys and labels, see Action Link Labels in the Connect REST API Developer Guide. If none of the label key values make sense for an action link, set this field to None and enter a custom label name in the Label field."
    },
    "LinkType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "The type of action link. One of these values: Api—The action link calls a synchronous API at the action URL. Salesforce sets the status to SuccessfulStatus or FailedStatus based on the HTTP status code returned by your server. ApiAsync—The action link calls an asynchronous API at the action URL. The action remains in a PendingStatus state until a third party makes a request to /connect/action-links/actionLinkId to set the status to SuccessfulStatus or FailedStatus when the asynchronous operation is complete. Download—The action link downloads a file from the action URL. Ui—The action link takes the user to a web page at the action URL."
    },
    "Method": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "HTTP method for the action URL. One of these values: HttpDelete—Returns HTTP 204 on success. Response body or output class is empty. HttpGet—Returns HTTP 200 on success. HttpHead—Returns HTTP 200 on success. Response body or output class is empty. HttpPatch—Returns HTTP 200 on success or HTTP 204 if the response body or output class is empty. HttpPost—Returns HTTP 201 on success or HTTP 204 if the response body or output class is empty. Exceptions are the batch posting resources and methods, which return HTTP 200 on success. HttpPut—Return HTTP 200 on success or HTTP 204 if the response body or output class is empty. Ui and Download action links must use HttpGet."
    },
    "Position": {
      "type": "int",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "An integer specifying the position of the action link template relative to other action links in the group. 0 is the first position."
    },
    "RequestBody": {
      "type": "textarea",
      "properties": "Create, Nillable, Update",
      "description": "Template for the HTTP request body sent when corresponding action links are invoked. This field can be used only for Api and ApiAsync action links. This field can contain context variables and binding variables in the form {!Bindings.key}."
    },
    "UserAlias": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "If you selected CustomUser or CustomExcludedUser for UserVisibility, this field is the alias for the custom user. Use the alias in a template binding to specify the custom user when an action link group is created using the template."
    },
    "UserVisibility": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "Who can see the action link. This value is set per action link, not per action link group. One of these values: Creator—Only the creator of the action link can see the action link. Everyone—Everyone can see the action link. EveryoneButCreator—Everyone but the creator of the action link can see the action link. Manager—Only the manager of the creator of the action link can see the action link. CustomUser—Only the custom user can see the action link. CustomExcludedUser—Everyone but the custom user can see the action link."
    }
  },
  "special_access_rules": "Only users with the “Customize Application” permission can modify or delete this object.",
  "usage": "Create action link templates in Setup. Use Apex classes in the ConnectApi namespace or Connect REST API to instantiate action links from templates and to post feed elements with the action links. For information about action links, see Working with Action Links in the Apex Developer Guide or the Connect REST API Developer Guide.\n\nCreate action link templates in Setup. Use Apex classes in the ConnectApi namespace or Connect REST API to instantiate action links from templates and to post feed elements with the action links.\n\nFor information about action links, see Working with Action Links in the Apex Developer Guide or the Connect REST API Developer Guide.",
  "wsdl_segment": "```xml\n<complexType name=\"ActionLinkTemplate\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"ActionLinkGroupTemplate\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ActionLinkGroupTemplate\"/>\n        <element name=\"ActionLinkGroupTemplateId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"ActionUrl\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Headers\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"IsConfirmationRequired\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsGroupDefault\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"Label\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"LabelKey\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LinkType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Method\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Position\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"RequestBody\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"UserAlias\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"UserVisibility\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n```",
  "field_reference": {
    "ActionLinkGroupTemplateId": {
      "field_label": "Action Link Group Template ID",
      "type": "reference",
      "length": "18"
    },
    "ActionUrl": {
      "field_label": "Action URL",
      "type": "textarea",
      "length": "32000"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "Headers": {
      "field_label": "HTTP Headers",
      "type": "textarea",
      "length": "32000"
    },
    "Id": {
      "field_label": "Action Link Template ID",
      "type": "id",
      "length": "18"
    },
    "IsConfirmationRequired": {
      "field_label": "Confirmation Required",
      "type": "boolean"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "IsGroupDefault": {
      "field_label": "Default Link in Group",
      "type": "boolean"
    },
    "Label": {
      "field_label": "Label",
      "type": "string",
      "length": "255"
    },
    "LabelKey": {
      "field_label": "Label Key",
      "type": "string",
      "length": "128"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LinkType": {
      "field_label": "Action Type",
      "type": "picklist",
      "length": "255"
    },
    "Method": {
      "field_label": "HTTP Method",
      "type": "picklist",
      "length": "255"
    },
    "Position": {
      "field_label": "Position",
      "type": "int",
      "digits": "9"
    },
    "RequestBody": {
      "field_label": "HTTP Request Body",
      "type": "textarea",
      "length": "32000"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "UserAlias": {
      "field_label": "Custom User Alias",
      "type": "string",
      "length": "128"
    },
    "UserVisibility": {
      "field_label": "User Visibility",
      "type": "picklist",
      "length": "255"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits"
  ]
}