Help Center/SecMaster/API Reference/API/Data Class Management/Querying the Data Class List
Updated on 2025-03-20 GMT+08:00
View PDF

Querying the Data Class List

Function

Querying the Data Class List

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/dataclasses

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

workspace_id

Yes

String

Workspace ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Offset

limit

No

Integer

Data volume

name

No

String

Name

business_code

No

String

Code

description

No

String

Description.

is_built_in

No

Boolean

Built-in or Not

Request Parameters

Table 3 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 a token.

content-type

Yes

String

Content type.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID, in the format request_uuid-timestamp-hostname.

Table 5 Response body parameters

Parameter

Type

Description

dataclass_details

Array of DataClassResponseBody objects

Data class details.

total

Number

Total data volume

Table 6 DataClassResponseBody

Parameter

Type

Description

id

String

Data class ID.

create_time

String

Creation time.

update_time

String

Update time.

creator_id

String

Creator ID.

creator_name

String

Creator username

modifier_id

String

ID of the user who updated the information.

modifier_name

String

Creator username

cloud_pack_version

String

Subscribed version.

region_id

String

Region ID

project_id

String

Tenant ID.

workspace_id

String

Workspace ID

domain_id

String

domain id

name

String

Data class name.

business_code

String

Service code for the data class.

description

String

Description of the data class.

is_built_in

Boolean

Whether the data class is built in SecMaster. The options are - true for built-in and false for outsourced.

parent_id

String

Parent data class ID.

type_num

Number

Quantity of sub-type data classes.

Status code: 400

Table 7 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID, in the format request_uuid-timestamp-hostname.

Table 8 Response body parameters

Parameter

Type

Description

code

String

Error Code

message

String

Error Description

Example Requests

Query the data object relationship list. The offset is 10, and three alerts are queried.

{
  "limit" : 3,
  "offset" : 10
}

Example Responses

Status code: 200

Request succeeded.

{
  "total" : 41,
  "dataclass_details" : [ {
    "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "create_time" : "2021-01-30T23:00:00Z+0800",
    "update_time" : "2021-01-30T23:00:00Z+0800",
    "creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "creator_name" : "Tom",
    "modifier_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "modifier_name" : "Jerry",
    "cloud_pack_version" : "Subscribed version.",
    "region_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "domain_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "name" : "Evidence",
    "business_code" : "Evidence",
    "description" : "Description of custom data classes.",
    "is_built_in" : false,
    "parent_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "type_num" : 9
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Response body of the failed requests for querying the data class list.

Error Codes

See Error Codes.

Parent Topic: Data Class Management