Skip to content
/Data Collection

Data Collection

The Data Collection operations are used to submit the data collection jobs and query the status of the submitted jobs.

Operations

Submit data collection job

Request

Submit a data collection job based on the specified RC template.

After the data collection job is submitted, the following validations are applied:

  • The specified RC template name must be valid.
  • For multi-organization tenants, the the organization ID is required and must be valid.
  • If there are more than 2 data collection jobs in Running/Pending/Incompatible status for the specified organization, the API request will be rejected with error message returned.
Security
bearerAuth
Bodyapplication/json; charset=utf-8required
rc_template_namestring

Name of the RC template that is defined in Zuora Revenue (Policies > RC Grouping Template).

org_idinteger

The organization ID that can be found in Zuora Revenue (Setups > Application > Organization). This field is required only for multi-organization tenants.

{
  "rc_template_name": "string",
  "org_id": 0
}

Responses

The request is submitted successfully and the job ID is returned. You can use the returned ID to query the job status later.

Bodyapplication/json; charset=utf-8
messagestring
successboolean
Response
{
  "message": "string",
  "success": true
}