Help Center/ DataArts Studio/ API Reference/ DataArts Architecture APIs/ Subject Management/ Querying Details of a Topic
Updated on 2025-09-18 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Details of a Topic

Function

This API is used to query details of a topic.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/design/subjects/{id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

id

Yes

String

Entity ID, which is a string
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

latest

No

Boolean

Indicates whether to query the latest.

with_relation

No

Boolean

Whether the conceptual model has relationships

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

data

Object

Returned data information.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Example Requests

View details about the topic whose ID is 1367232768567803904.

GET https://{endpoint}/v2/{project_id}/design/subjects/1367232768567803904

Example Responses

Status code: 200

The operation is successful, and CatalogVO is returned.

{
  "data" : {
    "value" : {
      "name_ch" : "Testing model",
      "name_en" : "BO000005",
      "description" : "None",
      "qualified_name" : "wgtest.wgtest_sync.BO000005@Business.0833a5737480d53b2f25c010dc1a7b88-workspace-eeb055e69c624311b6b9cfee89a4ec70",
      "guid" : null,
      "code" : null,
      "status" : "DRAFT",
      "new_biz" : null,
      "alias" : "",
      "data_owner" : "test_user",
      "data_owner_list" : "[\"ei_dayu_01_01\"]",
      "data_department" : null,
      "path" : "wgtest/wgtest synchronization/test conceptual model",
      "level" : 3,
      "ordinal" : 3,
      "owner" : "test_user",
      "parent_id" : "1323295154400018432",
      "swap_order_id" : null,
      "id" : "1367232768567803904",
      "qualified_id" : null,
      "from_public" : false,
      "create_by" : "test_user",
      "update_by" : "test_user",
      "create_time" : "2025-04-30T20:14:54+08:00",
      "update_time" : "2025-05-06T19:45:49+08:00",
      "self_defined_fields" : null,
      "children_num" : null,
      "children" : null,
      "relations" : null
    }
  }
}

Status code: 400

BadRequest

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user request is illegal."
}

Status code: 401

Unauthorized

{
  "error_code" : "DS.60xx",
  "error_msg" : "User authentication failed."
}

Status code: 403

Forbidden

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user does not have permission to call this API."
}

Status code: 404

Not Found

{
  "error_code" : "DS.60xx",
  "error_msg" : "The User Request API does not exist."
}

Status Codes

Status Code

Description

200

The operation is successful, and CatalogVO is returned.

400

BadRequest

401

Unauthorized

403

Forbidden

404

Not Found
Parent Topic: Subject Management