Query Data by Attribute¶

Get the details of data objects according to data objects attributes. Data details include basic information, associated data objects, associated tags and tag attributes, and associated business terms.

Request Format¶

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

Request Parameters（URI）¶

Name	Location（Path/Query）	Mandatory/Optional	The data Type	Description
orgId	Query	Mandatory	String	The OU ID
typeId	Query	Mandatory	String	The type identifier
attributeName	Query	Mandatory	String	The unique attribute name
attributeValue	Query	Mandatory	String	The unique attribute value

Response Parameters¶

Name	Data Type	Description
data	json	Return the detailed information of the specific data object queried

data¶

Name	Data Type	Description
basic	json	The basic information of the data object
tags	jsonArray	The information of tags associated with the data object
terms	jsonArray	The information of terms associated with the data object
relationships	json	The information of objects associated with the data object

basic¶

Name	Data Type	Description
owner	String	Owned by
typeId	String	The type identifier
createdTime	timestamp	Created on
updatedTime	timestamp	Updated on
updatedBy	String	Updated by
createdBy	String	Created by
name	String	Name
attributes	json	The attribute. Expressed in the form of <key, value>. The value of key is determined according to the specific type definition represented by the type identifier, and the type of key is String, and the type of value is determined according to the specific type definition represented by the type identifier.

tags¶

Name	Data Type	Description
tagId	String	The tag ID
attributes	json	The tag attribute. Expressed in the form of <key, value>. The value of key is determined according to the specific type definition represented by the type identifier, and the type of key is String, and the type of value is determined according to the specific type definition represented by the type identifier.

terms¶

Name	Data Type	Description
termId	String	The term ID

relationships¶

Name	Data Type	Description
typeId	String	The type identifier of the associated data object
displayName	String	The display name of the associated data object
guid	String	The GUID of the associated data object

Samples¶

Request Sample¶

url:    https://{apigw-address}/data-catalog/v2.0/entities/uniqueAttrs/detail?orgId=yourOrgId&typeId=yourTypeId&attributeName=yourAttributeName&attributeValue=yourAttributeValue

method: GET

Content-Type: application/json

Return Sample¶

{
    "code": 0,
    "message": "",
    "data": {
        "basic": {
            "owner": null,
            "typeId": "yourTypeId",
            "updatedTime": 1623921622948,
            "updatedBy": "SYS",
            "createdBy": "SYS",
            "name": "cry654",
            "createdTime": 1623921622948,
            "attributes": {
                "turbineId": "cry654"
            }
        },
        "tags": [{
            "tagId": "test:test2",
            "attributes": {
                "attr1": "test",
                "attr2": 2
            }
        }],
        "terms": [{
                "termId": "test2"
            },
            {
                "termId": "test1"

            }
        ],
        "relationships": {
            "site": [{
                "typeId": "UD_test2",
                "displayName": "ch89",
                "guid": "43ce1497-cbc5-4787-9b46-803297361ec6"
            }],
            "physicalData": [{
                    "typeId": "UD_test3",
                    "displayName": "ch654",
                    "guid": "43ce1497-cbc5-4787-9b46-803297361ec5"
                },
                {
                    "typeId": "UD_test4",
                    "displayName": "cy6",
                    "guid": "43ce1497-cbc5-4787-9b46-803297361ec3"
                }
            ]
        }
    }
}

Error Code¶

Code	Message
41001	Parameters [%s] required.
41130	The entity whose attribute [%s] is [%s] is not unique!
41090	Atlas detail error msg: %s.
41122	Entity is not exist,guid is [%s].
41141	Entity does not exist, attribute info is [%s].
41146	attribute [%s] not exist or not support to search.
42039	Attribute[%s] value does not match type.
99000	Internal Server Error.

Note¶

If the attribute value of the data object passed is not unique, an error will be reported.