Help Center/ SecMaster/ API Reference/ SecMaster APIs (Excluding APIs for Security Analysis V2)/ Incident Relationship Management/ Batch Associating Data Objects
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Batch Associating Data Objects

Function

This API is used to batch associate data objects.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/{dataclass_type}/{related_dataclass_type}/batch-create

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_type

Yes

String

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

related_dataclass_type

Yes

String

Data class the associated data object belongs to. The value must be plural and written in lowercase, for example, "alerts" and "incidents".

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A

content-type

Yes

String

Definition

Content type.

  • application/json;charset=UTF-8: common API request type

Constraints

N/A

Range

  • application/json;charset=UTF-8

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

dataobject_ids

No

Array of strings

The ID list of associated data objects.

related_dataobject_ids

No

Array of strings

ID list of associated data objects.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

code

String

Error code.

message

String

Error message.

request_id

String

The request ID.

total

Integer

Total number.

limit

Integer

The number of records on each page.

offset

Integer

Offset.

success

Boolean

Successful or not.

data

BatchOperateDataobjectResult object

Returned object for batch operation on alerts.
Table 5 BatchOperateDataobjectResult

Parameter

Type

Description

error_ids

Array of strings

Failed IDs.

success_ids

Array of strings

Succeeded IDs.

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 body for batch associating data objects.

400

Response body for failed requests for batch associating data objects.

Error Codes

See Error Codes.