Updated on 2025-12-18 GMT+08:00

Querying the Data Object List

Function

This API is used to query the data object list.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/{dataclass_name}/search

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

limit

No

Integer

The number of records on each page.

offset

No

Integer

Offset.

sort_by

No

String

Sorting field: create_time | update_time

order

No

String

Sorting order. Options: DESC and ASC.

from_date

No

String

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

to_date

No

String

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

condition

No

condition object

Search condition expression.

Table 4 condition

Parameter

Mandatory

Type

Description

conditions

No

Array of conditions objects

Expression list.

logics

No

Array of strings

Expression name list.

Table 5 conditions

Parameter

Mandatory

Type

Description

name

No

String

Expression name.

data

No

Array of strings

Expression content list.

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

code

String

Error code.

message

String

Error message.

total

Integer

Total number.

limit

Integer

The number of records on each page.

offset

Integer

Offset.

success

Boolean

Successful or not.

data

Array of DataObjectDetail objects

Details list.

Table 7 DataObjectDetail

Parameter

Type

Description

create_time

String

Recording time, in the ISO 8601 format of "YYYY-MM-DDTHH:mm:ss.ms+Time zone". Time zone refers to where the incident occurred. If this parameter cannot be parsed, the default time zone GMT+8 is used.

dataobject

Object

Data objects.

dataclass_ref

dataclass_ref object

Data class object.

format_version

Integer

Format version.

id

String

Unique identifier of an incident. The value is in UUID format and can contain a maximum of 36 characters.

project_id

String

ID of the current project.

update_time

String

Update time, in the ISO 8601 format of "YYYY-MM-DDTHH:mm:ss.ms+Time zone". Time zone refers to where the incident occurred. If this parameter cannot be parsed, the default time zone GMT+8 is used.

version

Integer

Version.

workspace_id

String

ID of the current workspace.

Table 8 dataclass_ref

Parameter

Type

Description

id

String

Unique identifier of a data class. The value is in UUID format and can contain a maximum of 36 characters.

name

String

Data class name.

Status code: 400

Table 9 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 querying the data object list.

400

Response body for failed requests for querying the data object list.

Error Codes

See Error Codes.