Retrieve a list of sync action definitions for a custom object
get
/api/bulk/2.0/customObjects/{parentId}/syncActions
Retrieves a list of sync action definitions for the specified custom object.
Request
Supported Media Types
- application/json
- text/csv
Path Parameters
Query Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : CustomObjectSyncActionOperationSearchResponse
Type:
object
Title:
Show Source
CustomObjectSyncActionOperationSearchResponse
-
count:
integer
Title:
count
-
hasMore:
boolean
Title:
hasMore
-
items:
array items
Title:
items
-
limit:
integer
Title:
limit
-
offset:
integer
Title:
offset
-
totalResults:
integer(int64)
Title:
totalResults
Nested Schema : items
Type:
array
Title:
Show Source
items
-
Array of:
object SyncActionOperation
Title:
SyncActionOperation
Nested Schema : SyncActionOperation
Type:
object
Title:
Show Source
SyncActionOperation
-
createdAt:
string(date-time)
Title:
createdAt
-
createdBy:
string
Title:
createdBy
-
fields:
object fields
Title:
fields
-
identifierFieldName:
string
Title:
identifierFieldName
-
isSyncTriggeredOnImport:
boolean
Title:
isSyncTriggeredOnImport
-
kbUsed:
integer(int64)
Title:
kbUsed
-
name:
string
Title:
name
-
syncActions:
array syncActions
Title:
syncActions
-
updatedAt:
string(date-time)
Title:
updatedAt
-
updatedBy:
string
Title:
updatedBy
-
uri:
string
Title:
uri
Nested Schema : fields
Type:
object
Title:
fields
Nested Schema : syncActions
Type:
array
Title:
Show Source
syncActions
-
Array of:
object SyncAction
Title:
SyncAction
Nested Schema : SyncAction
Type:
object
Title:
Show Source
SyncAction
-
action:
string
Title:
SyncActionType
Default Value:add
Allowed Values:[ "add", "remove", "setStatus" ]
-
destination:
string
Title:
destination
-
status:
string
Title:
MemberStatus
Default Value:bounced
Allowed Values:[ "bounced", "subscribed", "unsubscribed", "active", "complete", "pending", "errored", "yes", "no", "invalid", "permission" ]
-
updateAll:
boolean
Title:
updateAll
400 Response
Bad request. See Status Codes for information about other possible HTTP status codes.
401 Response
Unauthorized. See Status Codes for information about other possible HTTP status codes.
403 Response
Forbidden. See Status Codes for information about other possible HTTP status codes.
404 Response
The requested resource was not found. See Status Codes for information about other possible HTTP status codes.
409 Response
There was a conflict. See Status Codes for information about other possible HTTP status codes.
410 Response
The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes.
412 Response
The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes.
413 Response
Storage space exceeded. See Status Codes for information about other possible HTTP status codes.
500 Response
The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes.
503 Response
There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes.
Examples
The following examples demonstrate how to retrieve a list of custom object sync action definitions using an HTTP request and cURL. For more information on requests, see API requests.
HTTP Request Example
Retrieve a list of sync action definitions for a custom object with the id = 9:
GET /customObjects/9/syncActions
Response:
{
"items": [
{
"name": "Bulk Sync Action - Custom Object - Complete Status",
"fields": {
"Id": "{{CustomObject[9].ExternalId}}"
},
"identifierFieldName": "Id",
"syncActions": [
{
"destination": "{{ActionInstance(0122fdcfd3544a1c8c96ed58fcf4c1c3).Execution[11]}}",
"action": "setStatus",
"status": "complete"
}
],
"isSyncTriggeredOnImport": false,
"uri": "/customObjects/9/syncActions/6",
"createdBy": "API.User",
"createdAt": "2016-06-03T19:04:29.0600000Z",
"updatedBy": "API.User",
"updatedAt": "2016-06-03T19:32:17.5230000Z"
},
{
"name": "Bulk Sync Action - Custom Object - Active Status",
"fields": {
"Id": "{{CustomObject[9].ExternalId}}"
},
"identifierFieldName": "Id",
"syncActions": [
{
"destination": "{{ActionInstance(0122fdcfd3544a1c8c96ed58fcf4c1c3).Execution[11]}}",
"action": "setStatus",
"status": "active"
}
],
"isSyncTriggeredOnImport": false,
"uri": "/customObjects/9/syncActions/7",
"createdBy": "API.User",
"createdAt": "2016-06-03T19:32:40.9770000Z",
"updatedBy": "API.User",
"updatedAt": "2016-06-03T19:32:40.9770000Z"
},
{
"name": "Bulk Sync Action - Custom Object - Errored Status",
"fields": {
"Id": "{{CustomObject[9].ExternalId}}"
},
"identifierFieldName": "Id",
"syncActions": [
{
"destination": "{{ActionInstance(0122fdcfd3544a1c8c96ed58fcf4c1c3).Execution[11]}}",
"action": "setStatus",
"status": "errored"
}
],
"isSyncTriggeredOnImport": false,
"uri": "/customObjects/9/syncActions/8",
"createdBy": "API.User",
"createdAt": "2016-06-03T19:32:57.3700000Z",
"updatedBy": "API.User",
"updatedAt": "2016-06-03T19:32:57.3700000Z"
}
],
"totalResults": 3,
"limit": 1000,
"offset": 0,
"count": 3,
"hasMore": false
}
cURL Example
Here is the same example in cURL given an instance with the name APITest
, username API.User
, and POD of 3
.
curl --user "APITest\API.User" --request GET https://secure.p03.eloqua.com/api/bulk/2.0/customObjects/9/syncActions