Data Labeling

Retrieve a data labeling job

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

get/v1/multi-organizations/data-labeling-job/{job-id}

Request

  • Base URL: https://rest.test.zuora.com
  • URL: https://rest.test.zuora.com/v1/multi-organizations/data-labeling-job/{job-id}
  • Auth: HTTP bearer

Path parameters

job-idstring uuid required

Identifier of the data labeling job.

Headers

Accept-Encodingstring

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-Encodingstring

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.

Zuora-Entity-Idsstring

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-Idstring

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 (').

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

jobIdstring uuid

Identifier of the data labeling job.

jobStatus'Accepted' | 'Dispatched' | 'Completed'

Status of the data labeling job.

  • Accepted - The data labeling job has been accepted by the system.
  • Dispatched - The data labeling job is dispatched to the data labeling service.
  • Completed - The data labeling job has completed. Please note that Completed simply means the data labeling job has completed, but it does not mean the data labeling job has labeled all the data. You can check the progress field to see how many data have been labeled, failed or timeout.
objectTypestring

The object type of the data labeling job.

successboolean

Indicates whether the job was submitted successfully.

totalObjectinteger

The total number of objects to be labeled.

Changes

No operation changes recorded.