Starting or Stopping a Quality Job

This API is used to start or stop a quality job in DataArts Quality.

For details, see Calling APIs.

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

POST /v2/{project_id}/quality/quality-tasks/action

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Project ID and Account ID.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
workspace	Yes	String	DataArts Studio workspace ID. For details about how to obtain it, see Instance ID and Workspace ID.
X-Auth-Token	Yes	String	IAM token. For details about how to obtain it, see Authentication.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
action	No	String	Action. start indicates starting scheduling, and stop indicates stopping scheduling.
rule_id	No	String	Quality job ID. You can obtain it by calling the API for obtaining the quality job list.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
message	String	Returned message

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DQC.0000 which indicates that the request was successfully processed
error_msg	String	Error message

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DQC.0000 which indicates that the request was successfully processed
error_msg	String	Error message

Start scheduling of a job.

POST https://{endpoint}/v2/{project_id}/quality/quality-tasks/action

{
  "action" : "start",
  "rule_id" : 1200372516590559232
}

None

Parent Topic: Quality Jobs

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.