Jump to

• Request
• Response
• Examples

Retrieve a list of import definitions for a custom object

get

/api/bulk/2.0/customObjects/{parentId}/imports

Retrieves the list of import definitions for the custom object with the specified id.

Request

Supported Media Types

• application/json
• text/csv

Path Parameters

• parentId: 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 : CustomObjectImportSearchResponse

Type: object

Title: CustomObjectImportSearchResponse

Show Source

• count(optional): integer
  Title: count
• hasMore(optional): boolean
  Title: hasMore
• items(optional): array items
  Title: items
• limit(optional): integer
  Title: limit
• offset(optional): integer
  Title: offset
• totalResults(optional): integer(int64)
  Title: totalResults

{
    "title":"CustomObjectImportSearchResponse",
    "description":"",
    "properties":{
        "count":{
            "title":"count",
            "description":"",
            "type":"integer"
        },
        "hasMore":{
            "title":"hasMore",
            "description":"",
            "type":"boolean"
        },
        "items":{
            "title":"items",
            "description":"",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Import"
            }
        },
        "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 Import
  Title: Import

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

Nested Schema : Import

Type: object

Title: Import

Show Source

• autoDeleteDuration(optional): string
  Title: autoDeleteDuration
• createdAt(optional): string(date-time)
  Title: createdAt
• createdBy(optional): string
  Title: createdBy
• dataRetentionDuration(optional): string
  Title: dataRetentionDuration
• externalSystemId(optional): integer
  Title: externalSystemId
• fields(optional): object fields
  Title: fields
• identifierFieldName(optional): string
  Title: identifierFieldName
• importPriorityUri(optional): string
  Title: importPriorityUri
• isSyncTriggeredOnImport(optional): boolean
  Title: isSyncTriggeredOnImport
• isUpdatingMultipleMatchedRecords(optional): boolean
  Title: isUpdatingMultipleMatchedRecords
• kbUsed(optional): integer(int64)
  Title: kbUsed
• name(optional): string
  Title: name
• nullIdentifierFieldName(optional): boolean
  Title: nullIdentifierFieldName
• syncActions(optional): array syncActions
  Title: syncActions
• updatedAt(optional): string(date-time)
  Title: updatedAt
• updatedBy(optional): string
  Title: updatedBy
• updateRule(optional): string
  Title: RuleType

  Default Value: always

  Allowed Values: [ "always", "ifNewIsNotNull", "ifExistingIsNull", "useFieldRule" ]
• updateRuleByField(optional): object updateRuleByField
  Title: updateRuleByField
• uri(optional): string
  Title: uri

{
    "title":"Import",
    "description":"",
    "properties":{
        "autoDeleteDuration":{
            "title":"autoDeleteDuration",
            "description":"",
            "type":"string"
        },
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"",
            "type":"string"
        },
        "dataRetentionDuration":{
            "title":"dataRetentionDuration",
            "description":"",
            "type":"string"
        },
        "externalSystemId":{
            "title":"externalSystemId",
            "description":"",
            "type":"integer"
        },
        "fields":{
            "title":"fields",
            "description":"",
            "type":"object"
        },
        "identifierFieldName":{
            "title":"identifierFieldName",
            "description":"",
            "type":"string"
        },
        "importPriorityUri":{
            "title":"importPriorityUri",
            "description":"",
            "type":"string"
        },
        "isSyncTriggeredOnImport":{
            "title":"isSyncTriggeredOnImport",
            "description":"",
            "type":"boolean"
        },
        "isUpdatingMultipleMatchedRecords":{
            "title":"isUpdatingMultipleMatchedRecords",
            "description":"",
            "type":"boolean"
        },
        "kbUsed":{
            "format":"int64",
            "title":"kbUsed",
            "description":"",
            "type":"integer"
        },
        "name":{
            "title":"name",
            "description":"",
            "type":"string"
        },
        "nullIdentifierFieldName":{
            "title":"nullIdentifierFieldName",
            "description":"",
            "type":"boolean"
        },
        "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"
        },
        "updateRule":{
            "$ref":"#/definitions/RuleType"
        },
        "updateRuleByField":{
            "title":"updateRuleByField",
            "description":"",
            "type":"object"
        },
        "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 : updateRuleByField

Type: object

Title: updateRuleByField

Nested Schema : SyncAction

Type: object

Title: SyncAction

Show Source

• action(optional): string
  Title: SyncActionType

  Default Value: add

  Allowed Values: [ "add", "remove", "setStatus" ]
• destination(optional): string
  Title: destination
• status(optional): string
  Title: MemberStatus

  Default Value: bounced

  Allowed Values: [ "bounced", "subscribed", "unsubscribed", "active", "complete", "pending", "errored", "yes", "no", "invalid", "permission" ]
• updateAll(optional): 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 import definitions for a custom object using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Requests a single import definitions for the custom object with id #26:

GET /customObjects/26/imports?limit=1
			

Response:

{
    "count": 1,
    "hasMore": false,
    "items": [
        {
            "createdAt": "2014-08-13T14:20:21.3430000Z",
            "createdBy": "Docs.Example",
            "fields": {
                "email": "{{CustomObject[26].Field[510]}}"
            },
            "identifierFieldName": "email",
            "isSyncTriggeredOnImport": false,
            "isUpdatingMultipleMatchedRecords": false,
            "name": "Example Custom Object Import",
            "syncActions": [],
            "updatedAt": "2014-08-13T14:20:21.3430000Z",
            "updatedBy": "Docs.Example",
            "uri": "/customObjects/26/imports/1672"
        }
    ],
    "limit": 1,
    "offset": 0,
    "totalResults": 1
}
			

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/26/imports?limit=1
			

Back to Top