| actionUrl |
string |
Required. 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://.
|
| headers |
string |
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 |
boolean |
Required. If true, a confirmation dialog
appears before the action is executed. |
| isGroupDefault |
boolean |
Required. 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 |
string |
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.
|
| labelKey |
string |
Required. 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.
|
| linkType |
ActionLinkType (enumeration of type
string) |
Required. 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 |
ActionLinkHttpMethod (enumeration of type
string) |
Required. 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 |
int |
Required. An integer specifying the position of the action link template
relative to other action links in the group. 0 is the first position. |
| requestBody |
string |
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 |
string |
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 |
ActionLinkUserVisibility (enumeration of type
string) |
Required. Who can see the action link. This value is set per action link, not
per action link group. Values are:
-
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.
|