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

Querying a Data Object

Function

Get dataobject info by id

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/datapanel/{dataclass}/data-objects/{dataobject_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.

Constraints

N/A

Range

N/A

Default Value

N/A

dataclass

Yes

String

Data class ID. You can call the Querying the Data Class List API to obtain the data class ID.

dataobject_id

Yes

String

ID of dataobject

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

Parameter

Type

Description

X-request-id

String

This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.

Table 4 Response body parameters

Parameter

Type

Description

id

String

Unique ID.

format_version

Integer

format_version

version

Integer

version

workspace_id

String

workspace id

project_id

String

project id

dataclass_ref

Object

dataclass ref object

create_date

String

create time

update_date

String

update time

type

String

Data type.

trigger_flag

Boolean

Trigger flag.

dataobject

Object

Data objects.

Table 5 dataclass_ref

Parameter

Type

Description

id

String

Data class ID.

name

String

Data class name.

Status code: 400

Table 6 Response header parameters

Parameter

Type

Description

X-request-id

String

This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.

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

Data object information.

400

Error response

Error Codes

See Error Codes.