Jobs

API Set Name: jobs

• GET /jobs
• GET /jobs/{id}
• Error Responses

API Description and Functional Purpose:

The jobs resource contains all background job activity and status.

Additional information:

• Jobs are generated by the application to manage and track contact imports and exports using the contactimports and contactexports APIs.
• The job information includes job status, job ID, job name, total items, completed items and start and end times.
• For import jobs specifically, jobs also include total records, number updated, number inserted, number rejected, duplicate records, invalid records and new records.
• Job names and IDs are given to the job automatically based on the API initiating the job type. For example, contactimports will assign the value of "ImportContacts" to the jobName.
• Jobs can have a status of "Scheduled", "Pending", "Processing", "Failed" and "Done".
• Jobs records are retained for 60 days.
• Job rejections and Import Rejections are downloadable in the UI.
• Job rejections are retained for 7 days.

Resource Associations:

The following resource collections are associated to this collection.

GET /jobs

Query String Parameters

?jobName=ImportContacts

?times%5Bstart%5D%5Bgt%5D=01-01-2018

?times%5Bstart%5D%5Bgte%5D=01-01-2018

?times%5Bstart%5D%5Blt%5D=01-01-2018

?times%5Bstart%5D%5Blte%5D=01-01-2018

?times%5Bend%5D%5Bgt%5D=01-01-2018

?times%5Bend%5D%5Bgte%5D=01-01-2018

?times%5Bend%5D%5Blt%5D=01-01-2018

?times%5Bend%5D%5Blte%5D=01-01-2018

?status=Scheduled

?page=3

?per_page=100

Example Request URIs

The following URI will retrieve all jobs and include all fields.

http://<path>/jobs

The following URI will retrieve the job with the "jobName" of "ImportContacts".

http://<path>/jobs?jobName=ImportContacts

The following URI will retrieve all jobs, but will only include jobs that have a "status" of "Failed".

http://<path>/jobs?status=Failed

The following URI will retrieve all jobs starting from the third page grouping jobs by 10. For example, page-1 would have included the first 10, page-2 the second group of 10 and so on.

http://<path>/jobs?page=3&per_page=10

GET /jobs/{id}

Example Request URIs

The following URI will retrieve the job with the "id" value of "123123".

http://<path>/jobs/123123

Error Responses

The Cordial API will return an error object with an errorKey and message if there is a problem with an API call. Below is a list of errors specific to the Jobs API endpoint, along with suggested modifications to resolve each error. If you receive an error from the Jobs API endpoint that is not listed in this table, it is likely recorded within the Global API Error Responses page.