Updated on 2022-09-15 GMT+08:00

Obtaining Asset Details by GUID

Function

This API is used to obtain the details of an asset (table) based on its GUID. The table details include the column information. You can also obtain the column information based on the column GUID.

URI

GET /v3/{project_id}/asset/entities/{guid}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

guid

Yes

String

Asset GUID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

IAM Token

workspace

Yes

String

DGC workspace ID

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

entity

entity object

Asset details entity

referred_entities

Object

Referenced entity

Table 4 entity

Parameter

Type

Description

attributes

Object

Attributes (which can be obtained using Map<String, Object>)

connection

Connection object

Data connection

create_time

String

Creation time

created_by

String

Creator

display_text

String

Asset name

guid

String

Asset GUID

relationship_attributes

Object

Related attributes (which can be obtained using Map<String, Object>)

type_name

String

Asset type

updated_by

String

Updated by

update_time

String

Update time

tags

Array of TagHeader objects

Tags, which can be obtained using List

classification_names

Array of strings

Classification names, which can be obtained using List

Table 5 Connection

Parameter

Type

Description

guid

String

Associated GUID

dispaly_text

String

Displayed content

type_name

String

Type name

connection_type

String

Connection type

qualified_name

String

Qualified name

Table 6 TagHeader

Parameter

Type

Description

name

String

Asset name

dexcription

Object

Tag description

display_text

String

Tag name

relation_guid

String

Associated GUID

tag_guid

String

GUID associated with the tag

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Requests

None

Example Responses

Status code: 200

ok

{
  "entity" : {
    "attributes" : {
      "code" : "d96c8f4e-7f59-4313-bed2-b68ef60e31b9",
      "standardClassify" : null,
      "description" : "",
      "rule" : null,
      "type" : "STRING",
      "standardCode" : null,
      "securityLevel" : null,
      "propertyType" : "DIM",
      "alias" : "",
      "definition" : null,
      "workspaceId" : "61aa10df45e54431a1901cb3527adab8",
      "owner" : "",
      "synonyms" : null,
      "length" : 0,
      "updateTime" : 1661908856022,
      "dataMaintainOwner" : null,
      "hasValueList" : false,
      "nameEng" : "name",
      "linkedStandardType" : null,
      "selfDefinedFields" : null,
      "dataMonitorOwner" : null,
      "qualified_name" : "subject_area_group.subject_area.object.dli_table.name@Business.0833a5737480d53b2f25c010dc1a7b88-workspace-61aa10df45e54431a1901cb3527adab8",
      "createTime" : 1661908856022,
      "name" : "Name",
      "ruleOwner" : null,
      "valueExample" : null,
      "valueScope" : null,
      "parameters" : null
    },
    "classification_names" : null,
    "connection" : null,
    "create_time" : 1661908450270,
    "created_by" : "ei_dayu_y00321344_01",
    "display_text" : "Name",
    "guid" : "d05187d0-adb0-4953-8239-eedb88c21b30",
    "relationship_attributes" : {
      "tableColumn" : {
        "display_text" : null,
        "guid" : "6e02fcf2-7e66-4a32-bded-1d98790a4397",
        "relationship_attributes" : null,
        "relationship_guid" : null,
        "type_name" : null
      },
      "entity" : {
        "display_text" : null,
        "guid" : "a970c4fb-ac97-4339-95e6-944912c58a2b",
        "relationship_attributes" : null,
        "relationship_guid" : null,
        "type_name" : null
      },
      "tags" : [ ]
    },
    "tags" : [ ],
    "type_name" : "BusinessLogicEntityColumn",
    "update_time" : 1661908450270,
    "updated_by" : "ei_dayu_y00321344_01"
  },
  "referred_entities" : { }
}

Status Codes

Status Code

Description

200

ok

400

BadRequest

401

Unauthorized

403

Forbidden

404

Not Found