Updated on 2025-10-29 GMT+08:00

Querying Data Class Details

Function

show Dataclass

Calling Method

For details, see Calling APIs.

URI

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

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.

Range

N/A

dataclass_id

Yes

String

Unique ID of a data class.

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

Response Parameters

Status code: 200

Table 3 Response body parameters

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 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

400

Invalid request parameters.

500

Request failed.

Error Codes

See Error Codes.