API Reference

Search import jobs

get
https://{host}/platform/import/v1/jobs

Returns a list of import jobs.

This operation returns summary information about jobs initiated using the Import API. Import API jobs include the BULK_EDIT, CEDE_IMPORT, IMPORT_RDM, MRI_IMPORT, and OED_IMPORT jobs.

To learn more about managing and tracking jobs, see Platform Jobs.

This operation supports response filtering based the value of a subset of properties. Depending on the property, you may use a combination of comparison operators, list operators, and logical operators.

Query Params
string

Query string to select response data based on property values. Supported properties: endedAt, jobId, name, startedAt, status, type, userName Depending on the property, you may use comparison operators, list operators, and logical operators.

PropertyData TypeComparisonList
endedAtYYY-MM-DD=
jobIdstring=IN
namestring=
startedAtYYY-MM-DD=
statusstring=
typestring=
userNamestring=

See Filtering Responses.

string

Comma-delimited list of properties. Sort order defined by one of ASC (ascending) or DESC (descending).

Supported properties: endedAt, jobId, name, startedAt, status, type

int32

Number of records to display per page.

int32

Number of the page displaying the returned records, starting at 0.

Responses

Updated 5 months ago

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 5 months ago