Get ResponseFile

Retrieve information about a job, including whether its response file is ready.

When you set the job status to queued, orchestration starts. It applies your requested changes to the file you uploaded to S3, then generates a responseFileId. How long this takes depends on the size and complexity of the file.

Call this to check the status of the orchestration. A responseFileId that isn't null means orchestration has finished and the response file is available to download. A responseFileId of null means the process is still running.

get

Authorizations

AuthorizationstringRequired

Send Bearer {token}, where {token} is the access_token returned by Request a token.

Path parameters

jobIdstringRequired

The ID of the job. Returned by Job Create.

Responses

200

Returns the details of the job, including responseFileId.

No content

get/api/v2/job/{jobId}

GET /api/v2/job/{jobId} HTTP/1.1
Host: jobs.api.example.com
Authorization: YOUR_API_KEY
Accept: */*

200

Returns the details of the job, including responseFileId.

No content