Querying Technical Assets

Function

Query technology assets.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/asset/entities/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
query	Yes	String	Query keyword. If search_all_attributes is set to true, all attributes are matched. If search_all_attributes is set to false, only the name and description are matched. The default value is false.
type_names	Yes	Array of strings	Category name list.
connection_names	No	Array of strings	List of connection names.
search_all_attributes	No	Boolean	Indicates whether the query keyword matches the asset name and description. The options are as follows: true: match all attributes; false: match only the asset name and description. The default value is false.
tags	No	Array of strings	Tag names
limit	Yes	Integer	Number of results displayed on each page. Default value: 10.
offset	No	Integer	Offset. The default value is 0.
attributes	No	Object	Currently, key can be set to Table, and value can be set to rowCounts, tableSize, database, schema, namespace, ddlUpdateTime, dataUpdateTime or ddlCreateTime Map(String,Set(String)).
filter_criteria	No	FilterCriteria object	Filter criteria.
time_range	No	TimeRange object	Indicates the time filter criteria. You can set the filter criteria to filter assets.
scroll_id	No	String	scroll_id.
security_levels	No	Array of strings	Confidentiality list.
is_import	No	Boolean	Whether to import.
classifications	No	Array of strings	Category List
description	No	String	Description

**Table 4** FilterCriteria
Parameter	Mandatory	Type	Description
name	Yes	String	The value can be database.
value	Yes	String	Name of the database.
operator	Yes	String	Specifies the operation to be performed.

**Table 5** TimeRange
Parameter	Mandatory	Type	Description
time_type	Yes	String	Time type.
start	Yes	String	Start time
end	Yes	String	End time.

Response Parameters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
count	Integer	Total number of technology assets.
entities	Array of OpenEntityHeader objects	List of technology assets.
scroll_id	String	scroll_id

**Table 7** 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 8** 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 9** 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: 400

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

Status code: 401

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

Status code: 403

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

Status code: 404

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

Status code: 500

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

Example Requests

{
  "search_all_attributes" : true,
  "offset" : 0,
  "limit" : 10,
  "type_names" : [ "Database" ],
  "query" : "cbu_training"
}

Example Responses

Status code: 200

OK.

{
  "count" : 1,
  "entities" : [ {
    "attributes" : {
      "owner" : "wangyongjie",
      "create_time" : null,
      "qualified_name" : "cbu_training@dli.0833a5737480d53b2f25c010dc1a7b88-workspace-61aa10df45e54431a1901cb3527adab8",
      "name" : "cbu_training",
      "description" : "",
      "security_level" : null
    },
    "classification_names" : [ ],
    "connection" : {
      "connection_type" : "dli",
      "display_text" : "dli",
      "guid" : "0fff4057-c206-4dc3-a4ac-73ffc332bc9a",
      "qualified_name" : "dli@0833a5737480d53b2f25c010dc1a7b88-workspace-61aa10df45e54431a1901cb3527adab8",
      "type_name" : "Connection"
    },
    "display_text" : "cbu_training",
    "guid" : "e2b12c35-48ee-441f-a357-e338a85f5d00",
    "tags" : [ ],
    "type_name" : "dli_database"
  } ],
  "scroll_id" : null
}

Status Codes

Status Code	Description
200	OK.
400	Bad Request:
401	Unauthorized:
403	Forbidden.
404	Not found.
500	InternalServerError.

Parent Topic: Asset Management

Previous topic: Asset Management

Next topic: Obtaining Asset Details by GUID

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.