POST
/api/cloud/1.0/actions/instances
Retrieves information for up to 200 action service instances, searched by service instance GUID.
Important: Request header 'X-HTTP-Method-Override' needs to be set with value 'SEARCH'.
Request parameters
Name |
Type |
Description |
Possible values |
---|---|---|---|
ids |
array of GUIDs |
The unique identifiers for the service instances to retrieve. Maximum of 200 GUIDs per request.
|
d7a34c94-c370-4958-8a88-b56d5621e68a |
Response parameters
Name |
Type |
Description |
---|---|---|
recordDefinition | Dictionary of strings | The field mapping used in the service instance. |
requiresConfiguration | boolean | Whether or not user configuration is required before the service can be used. |
statement | string | The markup language statement used for referencing. |
dependentAssetType | string | The asset type for which the service instance is being used. Possible values include: Campaign or Program . For example, if the service is on a campaign canvas, the dependentAssetType would be Campaign . |
dependentAssetId | string | The asset Id for the asset for which the service instance is being used in. |
uri | string | System-generated unique resource identifier. |
createdBy | string | The login id of the user who created the service instance. |
createdAt | string | The date and time the service instance was created, expressed in Unix time. |
updatedBy | string | The login id of the user that last updated the service instance. |
updatedAt | string | The date and time the service instance was last updated, expressed in Unix time. |
Example
Retrieve 2 action service instances:
POST api/cloud/1.0/actions/instances
X-HTTP-Method-Override: SEARCH
Content-Type: application/json
Request body:
{
"ids": [
"d7a34c94-c370-4958-8a88-b56d5621e68a",
"1869b464-56f2-4334-923a-e631849d3cc8"
]
}
Response:
{
"items": [
{
"recordDefinition": {
"Id": "{{Contact.Id}}",
"field2": "{{Contact.Field(C_FirstName)}}"
},
"requiresConfiguration": false,
"statement": "{{ActionInstance(d7a34c94c37049588a88b56d5621e68a)}}",
"dependentAssetType": "Campaign",
"dependentAssetId": 49251,
"uri": "/actions/618068/instances/d7a34c94c37049588a88b56d5621e68a",
"createdBy": "Admin.User",
"createdAt": "2017-03-03T15:31:32.8930000Z",
"updatedBy": "Admin.User",
"updatedAt": "2017-03-03T15:31:33.4000000Z"
},
{
"recordDefinition": {
"Email": "{{CustomObject[1].Field[4]}}"
},
"requiresConfiguration": false,
"statement": "{{ActionInstance(1869b46456f24334923ae631849d3cc8)}}",
"dependentAssetType": "Program",
"dependentAssetId": 49252,
"uri": "/actions/618068/instances/1869b46456f24334923ae631849d3cc8",
"createdBy": "Admin.User",
"createdAt": "2017-03-03T15:31:33.8930000Z",
"updatedBy": "Admin.User",
"updatedAt": "2017-03-03T15:31:34.2170000Z"
}
]
}