Querying Metric Assets

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

View PDF

Function

This API is used to query metric assets.

URI

POST /v3/{project_id}/asset/metric-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
architecture_guid	No	String	Metric asset ID
query	Yes	String	Query condition
limit	No	Integer	Maximum number of requests at a time
offset	No	Integer	Offset
search_name_description	No	Boolean	Whether to query assets by name and description
include_sub_architecture	No	Boolean	Whether to query submetrics

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
count	Integer	Number of metric assets
entities	Array of OpenEntityHeader objects	List of metric assets
scroll_Id	String	scroll_Id

**Table 5** OpenEntityHeader
Parameter	Type	Description
attributes	Object	Attributes
connection	Array of Connection objects	Data connection
display_text	String	Displayed text
guid	String	Asset GUID
type_name	String	Type name
tags	String	Tags
classification_names	Array of strings	Classification names

**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

Status code: 401

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

Status code: 403

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

Status code: 404

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

Example Requests

{
  "query" : "indicator"
}

Example Responses

Status code: 200

metric assets

{
  "count" : 1,
  "entities" : [ {
    "attributes" : {
      "owner" : "ei_dayu_y00321344_01",
      "path" : "/process_name_first/process_name_second",
      "create_time" : 1661910746000,
      "qualified_name" : "1014471843710640128.1014471946009714688.1014472726615900160@Business.0833a5737480d53b2f25c010dc1a7b88-workspace-61aa10df45e54431a1901cb3527adab8",
      "name" : "indicator",
      "description" : null,
      "definition" : "Indicator Example",
      "security_level" : null
    },
    "classification_names" : [ ],
    "connection" : null,
    "display_text" : "indicator",
    "guid" : "2fd90dc8-f130-47c2-b6a6-141761c4f9f4",
    "tags" : [ ],
    "type_name" : "BusinessMetric"
  } ],
  "scroll_id" : null
}