Help Center/ DataArts Studio/ API Reference/ DataArts Architecture APIs/ ER Modeling/ Viewing Relationship Details
Updated on 2025-11-17 GMT+08:00
View PDF

Viewing Relationship Details

Function

This API is used to obtain relationship details by ID.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/design/relation/{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.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header).

This field is mandatory for authentication using tokens.

workspace

Yes

String

Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.

X-Project-Id

No

String

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

This parameter is mandatory for API requests that use AK/SK authentication in multi-project scenarios.

Content-Type

No

String

Default value: application/json;charset=UTF-8

This parameter is optional. If the body is available, this parameter is mandatory. If the body is unavailable, you do not need to set this parameter or verify it.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

data object

data: unified outermost data structure of the returned result.
Table 5 data

Parameter

Type

Description

value

RelationVO object

value: unified outer data structure of the returned result.
Table 6 RelationVO

Parameter

Type

Description

id

String

ID, which is a string

source_table_id

String

Source table ID, which is a string

target_table_id

String

Destination table ID, which is a string

name

String

Relationship name.

source_table_name

String

Name of the source table.

target_table_name

String

Name of the destination table.

role

String

Role.

tenant_id

String

Tenant ID.

source_type

String

Relationship type, which is read-only.

Options:

  • ONE: Each child (parent) logical entity has only one record in the parent (child) logical entity.

  • ZERO_OR_ONE: indicates that each child (parent) logical entity data record corresponds to only one data record in the parent (child) logical entity.

  • ZERO_OR_N: indicates that each child (parent) logical entity data record may correspond to multiple data records in the parent (child) logical entity.

  • ONE_OR_N: Each child (parent) logical entity corresponds to at least one data record in the parent (child) logical entity.

target_type

String

Relationship type, which is read-only.

Options:

  • ONE: Each child (parent) logical entity has only one record in the parent (child) logical entity.

  • ZERO_OR_ONE: indicates that each child (parent) logical entity data record corresponds to only one data record in the parent (child) logical entity.

  • ZERO_OR_N: indicates that each child (parent) logical entity data record may correspond to multiple data records in the parent (child) logical entity.

  • ONE_OR_N: Each child (parent) logical entity corresponds to at least one data record in the parent (child) logical entity.

create_by

String

Creator.

update_by

String

Person who updates the information.

create_time

String

Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

update_time

String

Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

mappings

Array of RelationMappingVO objects

Table attribute information, which is read-only.
Table 7 RelationMappingVO

Parameter

Type

Description

id

String

ID, which is a string

relation_id

String

Relationship ID, which is a string

source_field_id

String

Source field ID, which is a string

target_field_id

String

Destination field ID, which is a string

source_field_name

String

Name of the source table.

target_field_name

String

Name of the destination table.

create_by

String

Creator.

update_by

String

Person who updates the information.

create_time

String

Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

update_time

String

Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z.

Status code: 400

Table 8 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 9 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 10 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

This API queries relationship details by ID to obtain the relationship list.

GET https://{endpoint}/v2/{project_id}/design/relation/1225137038202957824

Example Responses

Status code: 200

This operation is successful, and the returned data is RelationVO details.

{
  "data" : {
    "value" : {
      "id" : "1225137038202957824",
      "source_table_id" : "1225137036110000128",
      "target_table_id" : "1225137037896773632",
      "name" : "left_relation_right_test",
      "source_table_name" : "test_left_relation",
      "target_table_name" : "test_right_test",
      "role" : null,
      "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-eeb055e69c624311b6b9cfee89a4ec70",
      "source_type" : "ONE",
      "target_type" : "ONE",
      "create_by" : "test_uesr",
      "update_by" : "test_uesr",
      "create_time" : "2024-04-03T17:37:12+08:00",
      "update_time" : "2024-04-03T17:37:12+08:00",
      "mappings" : [ {
        "id" : "1225137038211346432",
        "relation_id" : "1225137038202957824",
        "source_field_id" : "1225137036294549504",
        "target_field_id" : "1225137037896773633",
        "source_field_name" : "id",
        "target_field_name" : "id",
        "create_by" : "test_uesr",
        "update_by" : "test_uesr",
        "create_time" : "2024-04-03T17:37:12+08:00",
        "update_time" : "2024-04-03T17:37:12+08:00"
      } ]
    }
  }
}

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 Codes

Status Code

Description

200

This operation is successful, and the returned data is RelationVO details.

400

BadRequest

401

Unauthorized

403

Forbidden
Parent Topic: ER Modeling