Jump to

• Request
• Response
• Examples

Retrieve a list of import priorities

get

/api/bulk/2.0/imports/priorities

Retrieves a list of import priorities. Data import priority specifies the order in which Eloqua evaluates sources of data, and determines whether to update data in Eloqua. Data import priority is set within Eloqua.

Request

Supported Media Types

• application/json
• text/csv

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 : ImportPrioritySearchResponse

Type: object

Title: ImportPrioritySearchResponse

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

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

Nested Schema : ImportPriority

Type: object

Title: ImportPriority

Show Source

• createdAt(optional): string(date-time)
  Title: createdAt
• createdBy(optional): string
  Title: createdBy
• name(optional): string
  Title: name
• priority(optional): integer
  Title: priority
• updatedAt(optional): string(date-time)
  Title: updatedAt
• updatedBy(optional): string
  Title: updatedBy
• uri(optional): string
  Title: uri

{
    "title":"ImportPriority",
    "description":"",
    "properties":{
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"",
            "type":"string"
        },
        "name":{
            "title":"name",
            "description":"",
            "type":"string"
        },
        "priority":{
            "title":"priority",
            "description":"",
            "type":"integer"
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"",
            "type":"string"
        }
    }
}

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 priorities using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Retrieve the import priority list:

GET /imports/priorities
			

Response:

{
    "items":[
        {
            "name":"Bulk API",
            "priority":1,
            "uri":"/imports/priorities/100001",
            "createdAt":"2012-04-15T15:42:17.5270000Z",
            "updatedAt":"2012-04-15T15:42:17.5270000Z"
        },
        {
            "name":"CRM Integration",
            "priority":2,
            "uri":"/imports/priorities/100002",
            "createdAt":"2012-04-15T15:42:17.5370000Z",
            "updatedAt":"2012-04-15T15:42:17.5370000Z"
        },
        {
            "name":"Third-party data",
            "priority":3,
            "uri":"/imports/priorities/100003",
            "createdAt":"2012-04-15T15:42:17.5400000Z",
            "updatedAt":"2012-04-15T15:42:17.5400000Z"
        },
        {
            "name":"Eloqua Report",
            "priority":4,
            "uri":"/imports/priorities/100004",
            "createdAt":"2012-04-15T15:42:17.5470000Z",
            "updatedAt":"2012-04-15T15:42:17.5470000Z"
        },
        {
            "name":"Remote File over SFTP",
            "priority":5,
            "uri":"/imports/priorities/100005",
            "createdAt":"2012-04-15T15:42:17.5500000Z",
            "updatedAt":"2012-04-15T15:42:17.5500000Z"
        },
        {
            "name":"Manual upload",
            "priority":6,
            "uri":"/imports/priorities/100006",
            "createdAt":"2012-04-15T15:42:17.5500000Z",
            "updatedAt":"2012-04-15T15:42:17.5500000Z"
        }
    ],
    "totalResults":6,
    "limit":1000,
    "offset":0,
    "count":6,
    "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/imports/priorities
			

Back to Top