REST API for Oracle Eloqua Marketing Cloud Service

Retrieve a custom object sync action definition for a custom object

get

/api/bulk/2.0/customObjects/{parentId}/syncActions/{id}

Retrieve a custom object sync action definition for the specified custom object and sync action definition.

Request

Supported Media Types

application/json
text/csv

Path Parameters

id(required): integer
parentId(required): integer

Response

Supported Media Types

application/json

200 Response

OK.

Root Schema : CustomObjectSyncActionOperationIndividualResponse

Type: object

Title: CustomObjectSyncActionOperationIndividualResponse

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":"CustomObjectSyncActionOperationIndividualResponse",
    "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.

Examples

The following examples demonstrate how to retrieve a custom object sync action definition using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Retrieve the custom object sync action definition with the id = 11:


GET /customObjects/9/syncActions/11

Response:


{
    "name": "Test Sync Action",
    "statement": "{{EmailGroup[11]}}",
    "uri": "/syncActions/11",
    "createdBy": "API.User",
    "createdAt": "2015-05-21T20:23:49.8100000Z",
    "updatedBy": "API.User",
    "updatedAt": "2015-05-21T20:23:49.8100000Z"
}

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/11