Get an import job

get/lists/{listId}/importJobs/{jobId}
Internal-Use Only

Gets an import job resource to asynchronously load a list's contents.

When an import job is in progress, its state is 'running'. When an import job completes, its state is 'completed' or 'failed'.

Request Samples

1

Response Samples

1{
2 "id": "b791e348-984e-439d-bff4-5b4163d897af",
3 "version": 1,
4 "state": "completed",
5 "fileName": "data.csv",
6 "sha256Sum": "69091e2c774812266d577dc83472a2ab81687efde1e276feb0aaa77d637df11c",
7 "creationTimeStamp": "2022-05-31T14:31:57Z",
8 "createdBy": "userA",
9 "completedTimeStamp": "2022-05-31T14:32:57Z",
10 "listId": "3659ea38-2618-4474-aeac-0bf6cfd3c322",
11 "totalErrors": 1,
12 "results": {
13 "recordCount": 100
14 },
15 "errors": [
16 {
17 "message": "string",
18 "id": "string",
19 "errorCode": 0,
20 "httpStatusCode": 0,
21 "details": [
22 "string"
23 ],
24 "remediation": "string",
25 "version": 2
26 }
27 ],
28 "links": [
29 {
30 "href": "...",
31 "method": "...",
32 "rel": "...",
33 "uri": "..."
34 }
35 ]
36}

Path Parameters

NameTypeRequiredDescription
jobId
string
true

A universally unique identifier for an import job.

listId
string
true

A universally unique identifier for a list.

Responses

StatusMeaningDescription
200OKThe request succeeded.HeadersSchema
400Bad RequestThe request was invalid.Schema
403ForbiddenThe user did not have the necessary permissions.Schema
404Not FoundNo item exists at the requested path.Schema
500Internal Server ErrorThe request could not be fulfilled because of an unexpected server error.Schema