Retrieve a data labeling job

Retrieves a data labeling job. You can use this operation to track the status of the data labeling job.

Request
path Parameters
job-id
required
string <uuid> = 32 characters

Identifier of the data labeling job.

header Parameters
Accept-Encoding
string

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encoding
string

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Authorization
required
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Entity-Ids
string

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Track-Id
string <= 64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Responses
200

OK

404

Not Found

get/v1/multi-organizations/data-labeling-job/{job-id}
Request samples 
Response samples 
application/json
{
  • "jobId": "ff80808186b966950186b97922e200ab",
  • "jobStatus": "Completed",
  • "objectType": "Account",
  • "progress": {
    },
  • "success": true,
  • "totalObject": 11
}