Querying Metric Assets

Function

This API is used to query indicator assets.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Project ID and Account ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.
workspace	Yes	String	Workspace ID. For details about how to obtain it, see Instance ID and Workspace ID.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
architecture_guid	No	String	Indicator asset ID.
query	Yes	String	Indicates the query condition. If search_name_description is set to true, the query is performed by indicator name or description. If search_name_description is set to false, the query is performed by other indicator attributes.
limit	No	Integer	Number of requests at a time.
offset	No	Integer	Number of bytes to skip before starting to read data.
search_name_description	No	Boolean	Indicates whether to search by name and description.
include_sub_architecture	No	Boolean	Indicates whether to query sub-counters.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
count	Integer	Total number of indicator assets.
entities	Array of OpenEntityHeader objects	Indicates the indicator asset list.
scroll_id	String	scroll_Id

**Table 5** OpenEntityHeader
Parameter	Type	Description
attributes	Object	Attribute
connection	Connection object	Data connection.
display_text	String	Displays documents.
guid	String	Asset GUID.
type_name	String	Type name.
tags	Array of TagHeader objects	List of tags
classification_names	Array of strings	Category name list.

**Table 6** Connection
Parameter	Type	Description
guid	String	Associated GUID
display_text	String	Displayed content
type_name	String	Type name
connection_type	String	Connection type
qualified_name	String	Name of a restriction

**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	Specifies the GUID associated with the tag.

Status code: 401

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

Status code: 403

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

Status code: 404

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

Example Requests

{
  "query" : "indicator",
  "search_name_description" : true
}

Example Responses

Status code: 200

metric assets.

{
  "count" : 1,
  "entities" : [ {
    "attributes" : {
      "owner" : "username",
      "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
}