Updated on 2025-07-04 GMT+08:00

Associating with a Data Object

Function

This API is used to associate with a data object.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/{dataclass_type}/{data_object_id}/{related_dataclass_type}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

workspace_id

Yes

String

Workspace ID.

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".

data_object_id

Yes

String

ID of the associated data object.

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

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

content-type

Yes

String

Content type.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

ids

No

Array of strings

The ID list of associated data objects.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID. Format: request_uuid-timestamp-hostname.

Table 5 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 6 BatchOperateDataobjectResult

Parameter

Type

Description

error_ids

Array of strings

Failed IDs.

success_ids

Array of strings

Succeeded IDs.

Status code: 400

Table 7 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID. Format: request_uuid-timestamp-hostname.

Table 8 Response body parameters

Parameter

Type

Description

code

String

Error code.

message

String

Error description.

Example Requests

Create an incident relationship. Incident ID: f60bf0e7-73b8-4832-8fc4-8c2a12830552.

{
  "ids" : [ "f60bf0e7-73b8-4832-8fc4-8c2a12830552" ]
}

Example Responses

Status code: 200

Response body for the request for associating with a data object.

{
  "code" : 0,
  "message" : "Error message",
  "request_id" : "Error message",
  "success" : false,
  "total" : 41,
  "limit" : 3,
  "offset" : 10,
  "data" : {
    "success_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ],
    "error_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ]
  }
}

Status Codes

Status Code

Description

200

Response body for the request for associating with a data object.

400

Response body for failed requests for associating with a data object.

Error Codes

See Error Codes.