Jump to

• Request
• Response
• Examples

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

• parentId(required): integer

Query Parameters

• limit: integer
• links: string
• offset: integer
• orderBy: string
• q: string
• totalResults: boolean

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : CustomObjectSyncActionOperationSearchResponse

Type: object

Title: CustomObjectSyncActionOperationSearchResponse

Show Source

• 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

{
    "title":"CustomObjectSyncActionOperationSearchResponse",
    "description":"",
    "properties":{
        "count":{
            "title":"count",
            "description":"",
            "type":"integer"
        },
        "hasMore":{
            "title":"hasMore",
            "description":"",
            "type":"boolean"
        },
        "items":{
            "title":"items",
            "description":"",
            "type":"array",
            "items":{
                "$ref":"#/definitions/SyncActionOperation"
            }
        },
        "limit":{
            "title":"limit",
            "description":"",
            "type":"integer"
        },
        "offset":{
            "title":"offset",
            "description":"",
            "type":"integer"
        },
        "totalResults":{
            "format":"int64",
            "title":"totalResults",
            "description":"",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: array

Title: items

Show Source

• Array of: object SyncActionOperation
  Title: SyncActionOperation

{
    "title":"items",
    "description":"",
    "type":"array",
    "items":{
        "$ref":"#/definitions/SyncActionOperation"
    }
}

Nested Schema : SyncActionOperation

Type: object

Title: SyncActionOperation

Show Source

• 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

{
    "title":"SyncActionOperation",
    "description":"",
    "properties":{
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"",
            "type":"string"
        },
        "fields":{
            "title":"fields",
            "description":"",
            "type":"object"
        },
        "identifierFieldName":{
            "title":"identifierFieldName",
            "description":"",
            "type":"string"
        },
        "isSyncTriggeredOnImport":{
            "title":"isSyncTriggeredOnImport",
            "description":"",
            "type":"boolean"
        },
        "kbUsed":{
            "format":"int64",
            "title":"kbUsed",
            "description":"",
            "type":"integer"
        },
        "name":{
            "title":"name",
            "description":"",
            "type":"string"
        },
        "syncActions":{
            "title":"syncActions",
            "description":"",
            "type":"array",
            "items":{
                "$ref":"#/definitions/SyncAction"
            }
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"",
            "type":"string"
        }
    }
}

Nested Schema : fields

Type: object

Title: fields

Nested Schema : syncActions

Type: array

Title: syncActions

Show Source

• Array of: object SyncAction
  Title: SyncAction

{
    "title":"syncActions",
    "description":"",
    "type":"array",
    "items":{
        "$ref":"#/definitions/SyncAction"
    }
}

Nested Schema : SyncAction

Type: object

Title: SyncAction

Show Source

• 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

{
    "title":"SyncAction",
    "description":"",
    "properties":{
        "action":{
            "$ref":"#/definitions/SyncActionType"
        },
        "destination":{
            "title":"destination",
            "description":"",
            "type":"string"
        },
        "status":{
            "$ref":"#/definitions/MemberStatus"
        },
        "updateAll":{
            "title":"updateAll",
            "description":"",
            "type":"boolean"
        }
    }
}

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.

Back to Top

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
			

Back to Top