Help Center/ DataArts Studio/ API Reference/ DataArts Quality APIs/ Comparison Jobs/ Deleting Comparison Jobs
Updated on 2025-11-28 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Deleting Comparison Jobs

Function

This API is used to delete comparison jobs.

Calling Method

For details, see Calling APIs.

Authorization Information

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.

URI

POST /v2/{project_id}/quality/consistency-tasks/batch-delete

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.

Request Parameters

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

[items]

Yes

Array of longs

IDs of the comparison jobs to be deleted

Response Parameters

Status code: 200

Table 4 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: 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

Example Requests

Delete comparison jobs whose IDs are 1283480044387540993 and 1279033542491521025.

POST https://{endpoint}/v2/{project_id}/quality/consistency-tasks/batch-delete

[ 1283480044387540993, 1279033542491521025 ]

Example Responses

Status code: 200

Success

{
  "error_code" : "DLG.2700",
  "error_msg" : "Successful."
}

Status Codes

Status Code

Description

200

Success

400

BadRequest

500

INTERNAL SERVER ERROR
Parent Topic: Comparison Jobs