查询数据对象详情(根据 GUID 查询)

根据 guid 获取数据对象详情,包括基础信息、关联数据对象、关联标签及标签属性、关联业务术语。

请求格式

GET https://{apigw-address}/data-catalog/v2.0/entities/guids/{guid}/detail

请求参数(URI)

名称

位置(Path/Query)

必需/可选

数据类型

描述

guid

Path

必需

String

数据对象 GUID

orgId

Query

必需

String

组织 ID

响应参数

名称

数据类型

描述

data

json

返回查询到的具体数据对象详情信息

data

名称

数据类型

描述

basic

json

数据对象的基本信息

tags

jsonArray

数据对象关联的标签信息

terms

jsonArray

数据对象关联的术语信息

relationships

json

数据对象关联的数据对象信息

basic

名称

数据类型

描述

owner

String

所有者

typeId

String

类型标识符

createdTime

timestamp

创建时间

updatedTime

timestamp

更新时间

updatedBy

String

更新者

createdBy

String

创建者

name

String

名称

attributes

json

属性,以 json 的形式表示 <key,value> 键值对,key 的值根据类型标识符所表示的具体类型定义来确定,key 的类型为 String,value 的类型根据类型标识符所表示的具体类型定义来确定

tags

名称

数据类型

描述

tagId

String

标签 ID

attributes

json

标签属性,以 json 的形式表示 <key,value> 键值对,key 的值根据类型标识符所表示的具体类型定义来确定,key 的类型为 String,value 的类型根据类型标识符所表示的具体类型定义来确定

terms

名称

数据类型

描述

termId

String

术语 ID

relationships

名称

数据类型

描述

typeId

String

关联数据对象的类型标识符

displayName

String

关联数据对象的显示名称

guid

String

关联数据对象的系统 ID

示例

请求示例

url:    https://{apigw-address}/data-catalog/v2.0/entities/guids/{yourEntityGuid}/detail?orgId=yourOrgId

method: GET

Content-Type: application/json

返回示例

{
        "code": 0,
        "message": "",
        "data": {
                "basic": {
                        "owner": null,
                        "typeId": "UD_Test",
                        "updatedTime": 1623921622948,
                        "updatedBy": "SYS",
                        "createdBy": "SYS",
                        "name": "",
                        "createdTime": 1623921622948,
                        "attributes": {
                                "turbineId": "ch9876"
                        }
                },
                "tags": [{
                        "tagId": "testTagGroup:test",
                        "attributes": {
                                "string": "q",
                                "int": 1
                        }
                }],
                "terms": [{
                                "termId": "test2"
                        },
                        {
                                "termId": "test1"
                        }
                ],
                "relationships": {
                        "site": [{
                                "typeId": "UD_test2",
                                "displayName": "cr678",
                                "guid": "43ce1497-cbc5-4787-9b46-803297361ec6"
                        }],
                        "physicalData": [{
                                        "typeId": "UD_test3",
                                        "displayName": "cy765",
                                        "guid": "43ce1497-cbc5-4787-9b46-803297361ec6"
                                },
                                {
                                        "typeId": "UD_test4",
                                        "displayName": "cy735",
                                        "guid": "43ce1497-cbc5-4787-9b46-803297361ec6"
                                }
                        ]
                }
        }
}

错误码

代码

错误信息

41001

参数[%s]不能为空。

41090

Atlas详细错误信息: %s

41122

Entity不存在,guid为: [%s]。

99000

服务器内部错误。