Querying Logical Assets

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

View PDF

Function

This API is used to query logical assets.

URI

POST /v3/{project_id}/asset/business-assets/search

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	IAM Token
workspace	Yes	String	DGC workspace ID

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
search_all_attributes	Yes	Boolean	Whether to query all attributes by keyword. Value true means to query all attributes, and value false means to query only the name description.
tags	No	Object	Tag information
limit	Yes	Integer	Maximum number of assets to be returned
offset	Yes	Integer	Query offset
guid	No	String	GUID of the node on which you are to perform a query
query	Yes	String	Keyword used for the query
type	Yes	String	Query type Enumeration values: BUSINESS LOGICENTITY

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
count	Integer	Number of logical assets
assets	Array of OpenEntity objects	List of logical assets

**Table 5** OpenEntity
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	Created by
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
classification_names	Array of strings	Classification names (which can be obtained using List classificationNames)

**Table 6** 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 7** 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 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 401

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 403

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 404

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Example Requests

{
  "search_all_attributes" : false,
  "limit" : 10,
  "offset" : 0,
  "query" : "dli_table",
  "type" : "LOGICENTITY"
}

Example Responses

Status code: 200

Business assets

{
  "assets" : [ {
    "attributes" : {
      "owner" : "",
      "code" : "53f31e71-512a-41d8-81d8-7c49ce68d7b3",
      "description" : "None",
      "updateTime" : 1661908856018,
      "dataClassify" : "BASE_DATA",
      "securityLevel" : null,
      "nameEng" : "dli_table",
      "tables" : [ {
        "uniqueAttributes" : {
          "qualifiedName" : "cbu_training.dli_table@dli.0833a5737480d53b2f25c010dc1a7b88-workspace-61aa10df45e54431a1901cb3527adab8"
        },
        "type_name" : "dli_table_managed",
        "name" : "dli_table",
        "guid" : "d99a8270-63b5-4252-ad37-8cebe7530a73"
      } ],
      "selfDefinedFields" : null,
      "qualified_name" : "subject_area_group.subject_area.object.dli_table@Business.0833a5737480d53b2f25c010dc1a7b88-workspace-61aa10df45e54431a1901cb3527adab8",
      "createTime" : 1661908856018,
      "name" : "dli_table",
      "alias" : null,
      "fields" : [ {
        "type_name" : "BusinessLogicEntityColumn",
        "guid" : "d05187d0-adb0-4953-8239-eedb88c21b30"
      }, {
        "type_name" : "BusinessLogicEntityColumn",
        "guid" : "d75821b5-ef73-4650-ac4e-340b255db412"
      }, {
        "type_name" : "BusinessLogicEntityColumn",
        "guid" : "cd7e8939-50f7-4096-b4e4-9f7b73167a97"
      } ],
      "parameters" : null,
      "publishStatus" : null,
      "workspaceId" : "61aa10df45e54431a1901cb3527adab8"
    },
    "classification_names" : null,
    "connection" : null,
    "create_time" : 1661908450270,
    "created_by" : "ei_dayu_y00321344_01",
    "display_text" : "dli_table",
    "guid" : "a970c4fb-ac97-4339-95e6-944912c58a2b",
    "relationship_attributes" : {
      "tables" : [ {
        "display_text" : null,
        "guid" : "d99a8270-63b5-4252-ad37-8cebe7530a73",
        "relationship_attributes" : null,
        "relationship_guid" : null,
        "type_name" : null
      } ],
      "catelog" : {
        "display_text" : null,
        "guid" : "7fbed9da-331d-4695-b8fa-5587605f37e4",
        "relationship_attributes" : null,
        "relationship_guid" : null,
        "type_name" : null
      },
      "fields" : [ {
        "display_text" : null,
        "guid" : "d05187d0-adb0-4953-8239-eedb88c21b30",
        "relationship_attributes" : null,
        "relationship_guid" : null,
        "type_name" : null
      }, {
        "display_text" : null,
        "guid" : "d75821b5-ef73-4650-ac4e-340b255db412",
        "relationship_attributes" : null,
        "relationship_guid" : null,
        "type_name" : null
      }, {
        "display_text" : null,
        "guid" : "cd7e8939-50f7-4096-b4e4-9f7b73167a97",
        "relationship_attributes" : null,
        "relationship_guid" : null,
        "type_name" : null
      } ],
      "tags" : [ ]
    },
    "tags" : null,
    "type_name" : "BusinessLogicEntity",
    "update_time" : 1661908450270,
    "updated_by" : "ei_dayu_y00321344_01"
  } ],
  "count" : 1
}