Updated on 2025-10-29 GMT+08:00

Batch Deleting Data Objects

Function

This API is used to batch delete data objects.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/{project_id}/workspaces/{workspace_id}/soc/{dataclass_name}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Definition

Workspace ID.

Constraints

N/A

Range

N/A

Default Value

N/A

dataclass_name

Yes

String

Name of the data class the association subject data object belongs to. The value must be plural and written in lowercase, for example, "alerts" and "incidents".

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

batch_ids

No

Array of strings

List of IDs for the batch deletion.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

limit

Integer

The number of records on each page.

offset

Integer

Offset.

sort_by

String

Sorting field: create_time | update_time

order

String

Sorting order. Options: DESC and ASC.

from_date

String

Search start time, for example, 2023-02-20T00:00:00.000Z.

to_date

String

Search end time, for example, 2023-02-27T23:59:59.999Z.

condition

condition object

Search condition expression.

Table 4 condition

Parameter

Type

Description

conditions

Array of conditions objects

Expression list.

logics

Array of strings

Expression name list.

Table 5 conditions

Parameter

Type

Description

name

String

Expression name.

data

Array of strings

Expression content list.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Response for batch deleting data objects.

400

Error response

Error Codes

See Error Codes.