Deleting Build Tasks in Batches

Function

This API is used to delete build tasks in batches.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/job/batch-delete

Request Parameters

**Table 1** Request body parameters
Parameter	Mandatory	Type	Description
job_ids	Yes	Array of strings	A list if task IDs (Job IDs).

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
result	result object	Definition Data returned after the API is successfully called. Range N/A.
status	String	Definition Status information. Range ● success: The API call is successful. ● fail: The API call failed.
error	String	Definition Returned error message. Range N/A.

**Table 3** result
Parameter	Type	Description
job_id	String	Definition Build task ID. Range N/A.
project_id	String	Definition CodeArts project ID. ID of the project to which the build task belongs. Range N/A.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

DELETE https://{endpoint}/v1/job/03428afcfeed4f9ba463a2f7044abd4d/batch-delete

{
  "job_ids" : [ "436ab57485c94629b60d5c5fb02cb037", "34b1146d863044b6ade25d527169330d" ]
}

Example Responses

Status code: 200

{
  "result" : {
    "project_id" : "b4d3971c3988463b865f6f920846149e",
    "job_id" : "c798139500d2456d82d95d108f182b5a"
  },
  "error" : null,
  "status" : "success"
}