Skip to navigation
Multiple OrganizationsData Labeling

Submit a data labeling job

View as Markdown
Submits a data labeling job.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Headers

Idempotency-KeystringOptional<=255 characters
Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
Accept-EncodingstringOptional

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

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

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

Zuora-VersionstringOptional

The minor API version.

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

Request

This endpoint expects an object.
objectTypestringRequired

The object type of the data labeling job.

Currently, the following objects are supported:

  • User

  • Account

    All the associated transaction objects of the account being labeled will automatically inherit the org label of the account.

  • Product

    You have to label the Account object first, make sure all accounts have been labeled, then you can proceed with the Product object.

    You can get all the unlabeled accounts by running a Data Source export job, with the following query:

    SELECT Id, Name FROM Account WHERE Organization.Id IS NULL

    All the ProductRatePlanS of the product will be automatically labeled with the same orgs.

    When labeling products, you can omit the orgs parameter, i.e, leave it empty, the system will find all the subscriptions that include the product and get the org list of those subscriptions, then label the product with those orgs, aka, the derived orgs.

    You can also explicitly specify the orgs parameter, in that case, you will need to provide a super set of the derived orgs.

  • BillRun

    You don’t need to specify the orgs parameter, we will label the BillRun with all the orgs because existing runs could pick up all accounts. You can definitely create new bill run with certain orgs to operate separately by orgs.

  • PaymentRun

    Same as BillRun.

  • ForecastRun

queryTypeenumRequired

Specifies the type of query that the data labeling job will run to fetch the data to be labeled.

  • ByZoql - The data labeling job will run a ZOQL query which is specified in the query field to fetch the data to be labeled.
  • ById - The data labeling job will fetch the data to be labeled by the IDs specified in the ids field.
Allowed values:
idslist of stringsOptional

The IDs of the objects to be labeled, only required if the queryType is ById.

There is a 4MB limit of the JSON payload, so in case of a large number of IDs, please make sure the payload is less than 4MB.

orgIdslist of stringsOptional

The IDs of the organizations that the data labeling job will associate with the data to be labeled. Either the orgIds or orgs field is required.

For Account object, one and only one org Id is required.

For configuration objects, null and [] are treated differently, use null to unlabel the object, [] to label it with all orgs.

orgslist of stringsOptional

The names of the organizations that the data labeling job will associate with the data to be labeled. Either the orgIds or orgs field is required.

For Account object, one and only one org name is required.

For configuration objects, null and [] are treated differently, use null to unlabel the object, [] to label it with all orgs.

querystringOptional

The query that the data labeling job will run to fetch the data to be labeled, only required if the queryType is ByZoql.

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

  • application/json
  • application/xml
  • text/html
  • text/csv
  • text/plain
RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional
The Zuora internal identifier of the API call. You cannot control the value of this header.
Zuora-Track-IdstringOptional
A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
Concurrency-Limit-TypestringOptional

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Response

OK
jobIdstringOptionalformat: "uuid"=32 characters
Identifier of the data labeling job.
jobStatusenumOptional

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.
Allowed values:
successbooleanOptional
Indicates whether the job was submitted successfully.

Errors

400
Bad Request Error