Querying the Data Class List

Function

This API is used to query 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	Search by name.
business_code	No	String	Service 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 the user 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. 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 name.
modifier_id	String	ID of the editor.
modifier_name	String	Modifier name.
cloud_pack_version	String	Subscription package version.
region_id	String	Region ID.
project_id	String	Account ID.
workspace_id	String	Workspace ID.
domain_id	String	domain id
name	String	Data class name.
business_code	String	Business code of the data class.
description	String	Data class description.
is_built_in	Boolean	Built-in or not. true: Built in; false: Not built in.
parent_id	String	Parent ID.
type_num	Number	Number of subtypes.

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

Query the data class list. Offset: 10. Quantity: 3.

{
  "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" : "Peter",
    "cloud_pack_version" : "Subscribed package 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" : "Data class description.",
    "is_built_in" : false,
    "parent_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "type_num" : 9
  } ]
}