1. REST API for Oracle Eloqua Marketing Cloud Service
  2. Tasks
  3. Bulk
  4. 2.0
  5. customObjects

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
Path Parameters
Query Parameters
  • A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: ?limit=5.
  • The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
  • Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: ?offset=1000.
  • Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.
  • A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use "*" for wildcard values. Example: ?q="name=*Test*" will find all the entities where the "name" field contains the string "Test".
  • Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : CustomObjectSyncActionOperationSearchResponse
Type: object
Title: CustomObjectSyncActionOperationSearchResponse
The response body contains information about the custom object sync action definitions.
Show Source
  • Title: count
    Number of results returned in the request.
  • Title: hasMore
    Indicates if there are more results.
  • items
    Title: items
    The collection of items that match the search.
  • Title: limit
    The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.
  • Title: offset
    The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.
  • Title: totalResults
    Number of total results. Returned when the totalResults URL parameter is not set to false.
Nested Schema : items
Type: array
Title: items
The collection of items that match the search.
Show Source
  • SyncActionOperation
    Title: SyncActionOperation
    The request body defines the details of the sync action definition. The following table displays properties for creating sync action definitions.
Nested Schema : SyncActionOperation
Type: object
Title: SyncActionOperation
The request body defines the details of the sync action definition. The following table displays properties for creating sync action definitions.
Show Source
  • Title: createdAt
    The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
  • Title: createdBy
    The login id of the user who created the sync action. This is a read-only property.
  • fields
    Title: fields
    The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field. Allowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}. Allowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}. Allowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.
  • Title: identifierFieldName
    The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long.
  • Title: isSyncTriggeredOnImport
    Whether or not the sync is triggered upon uploading data.
  • Title: kbUsed
    The amount of space used in kb. This is a read-only property.
  • Title: name
    The name of the sync action definition.
  • syncActions
    Title: syncActions
    Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. There currently are not any sync actions available for Events.
  • Title: updatedAt
    The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
  • Title: updatedBy
    The login id of the user that last updated the entity. This is a read-only property.
  • Title: uri
    System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
Nested Schema : fields
Type: object
Title: fields
The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field. Allowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}. Allowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}. Allowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.
Nested Schema : syncActions
Type: array
Title: syncActions
Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. There currently are not any sync actions available for Events.
Show Source
Nested Schema : SyncAction
Type: object
Title: SyncAction
The definition of the action to take at time of syncronization.
Show Source
  • Title: SyncActionType
    Default Value: add
    Allowed Values: [ "add", "remove", "setStatus" ]
    The action to take at time of synchronization.
  • Title: destination
    The ML statement used to reference an object used by the action.
  • Title: MemberStatus
    Default Value: bounced
    Allowed Values: [ "bounced", "subscribed", "unsubscribed", "active", "complete", "pending", "errored", "yes", "no", "invalid", "permission" ]
    The status of members.
  • Title: updateAll
    Update status of all records in an execution.

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