Asset Search (Invitational Test)

Function

Asset search. It is in invitational test and will be available for OBT in the future.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/datamap/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.
instance	Yes	String	Instance ID. For details about how to obtain the instance ID, see Instance ID and Workspace ID.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
query	No	String	Keyword used for the query.
filter	No	DataMapFilterCriteria object	Filter condition object.
facets	No	Array of strings	List of condition parameters.
limit	Yes	Integer	Number of results displayed on each page. The default value is 100.
offset	Yes	Integer	Offset. The default value is 0.
relationship_attributes	No	Array of strings	Association attribute.
sort	No	Array of Sort objects	Sorting information.
owner	No	String	Owner.
query_privilege	No	Boolean	Indicates whether to verify the permission. The default value is false.

**Table 4** DataMapFilterCriteria
Parameter	Mandatory	Type	Description
attribute	No	String	Filter attribute dimension.
operator	No	String	Operation identifier.
value	No	Array of strings	Attribute filtering value, which varies depending on the attribute. If the attribute is base.DataAsset.sourceType, the value can be ["dws", "hive"].
condition	No	String	Condition combination rule.
criterion	No	Array of DataMapFilterCriteria objects	Condition criterion

**Table 5** Sort
Parameter	Mandatory	Type	Description
attribute	No	String	Attribute.
order	No	String	Enumerated value for sorting. The default value is ASC.

Response Parameters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
count	Number	Total number of query results.
entities	Array of Entity objects	Asset entity list.
facets	Array of objects	Indicates the facets dimension information list of the asset classification. The value of the data structure List<Map<String, List<Aggregation>>> is count.
metrics	Object	Indicates the metric dimension information list of the asset category. The value of the data structure List<Map<String, List<Aggregation>>> is aggregation.
referred_entities	Object	Associated asset. The data type is Map<String, Entity>. The key is guid and the value is asset information.

**Table 7** Entity
Parameter	Type	Description
version	Number	Data version.
relationship_attributes	Object	Association relationship attribute. The data type is Map<String, Object>. The options are as follows: key: relationship type; value: association relationship object.
super_type_names	Array of strings	Parent asset type.
business_attributes	Object	Service attribute. The data type is Map<String, Map<String, Object>>. The options are as follows: key: service relationship type; value: service relationship.
multi_attributes	Object	Multi-value object data structure that bears security levels and tags. The data structure is Map<String, List<Map<String, Object>>>. key indicates the comprehensive relationship type, and value indicates the comprehensive relationship.
privilege_info	EntityPrivilegeInfo object	Entity privilege information.
extended_attributes	Object	Extended attribute. The data structure is Map<String, Object>. The key field indicates the extended attribute, and the value field indicates the extended attribute value.
guid	String	Asset GUID.
type_name	String	Asset type name.
type_display_name	String	Type display name.
display_text	String	Display name.
attributes	Object	Asset attribute, which is a Map<String, Object>. The key is an attribute, and value is the attribute value.
updated_attributes	Array of strings	List of modified attributes.
project_id	String	Project ID
domain_id	String	Main account ID.
instance_id	Array of strings	Instantiation ID.
workspace_id	Array of strings	Workspace IDs
status	String	Status
created_by	String	Creator
updated_by	String	User who makes a modification.
create_time	String	Creation time.
update_time	String	Modification time.

**Table 8** EntityPrivilegeInfo
Parameter	Type	Description
privileges	Array of strings	Privilege list.
inherit_privileges	Array of strings	List of inherited privileges.

Status code: 400

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

Status code: 401

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

Status code: 403

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

Status code: 404

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

Status code: 500

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

Example Requests

{
  "query" : "",
  "filter" : {
    "attribute" : null,
    "condition" : "AND",
    "criterion" : [ {
      "attribute" : null,
      "condition" : "OR",
      "criterion" : [ {
        "attribute" : "superTypeNames",
        "operator" : "IN",
        "value" : [ "dataasset.Database" ]
      }, {
        "attribute" : "typeName",
        "operator" : "IN",
        "value" : [ "dataasset.Database" ]
      } ]
    }, {
      "attribute" : "base.DataAsset.sourceType",
      "operator" : "IN",
      "value" : [ "dli" ]
    } ]
  },
  "facets" : [ "category.path", "typeName", "base.DataAsset.sourceType", "classifications.name", "tags.name", "securityLevel.name", "workspaceId", "base.Asset.catalogId" ],
  "limit" : 10,
  "offset" : 1,
  "sort" : [ {
    "attribute" : "createTime",
    "order" : "DESC"
  } ]
}

Example Responses

Status code: 200

OK.

{
  "count" : 1234,
  "entities" : [ {
    "guid" : "a14d047e-3d67-4f71-90f0-53b6759a7fa5",
    "attributes" : {
      "owner" : "username",
      "is_favorite" : 0,
      "qualifiedName" : "dws@a96be22c-77f3-46ea-96ab-c8913052ec7d",
      "favorites_count" : 0,
      "description" : "This temp entity was generated from DLF lineage service",
      "clusterId" : "",
      "click_through" : 10,
      "baseType" : "Source",
      "path" : "",
      "catalogId" : "",
      "workspaceVsId" : { },
      "createTime" : "2022-12-09T01:59:42.319+00:00",
      "port" : 8000,
      "sourceType" : "dws",
      "name" : "dws_4autotest1_nomodify",
      "host" : "",
      "id" : "f9338475eb8c4cbda61b85c05908a432",
      "projectId" : ""
    },
    "status" : "ACTIVE",
    "version" : 0,
    "type_name" : "dataasset.Source",
    "type_display_name" : "Data sources",
    "project_id" : 123456,
    "domain_id" : 123456,
    "instance_id" : [ "123456" ],
    "workspace_id" : [ "123456" ],
    "updated_by" : "username",
    "create_time" : "2023-05-17T06:32:00.511+00:00",
    "update_time" : "2023-05-17T06:32:00.511+00:00",
    "super_type_names" : [ "base.Asset", "base.Infrastructure" ],
    "business_attributes" : {
      "businessName" : {
        "confidence" : 1.0,
        "name" : "dws0505",
        "confirmed" : true
      }
    },
    "multi_attributes" : {
      "tags" : [ {
        "confidence" : 1.0,
        "name" : "Mistaken deletion of personal data",
        "confirmed" : false
      } ]
    },
    "privilege_info" : {
      "privileges" : [ ],
      "inherit_privileges" : [ ]
    },
    "extended_attributes" : { },
    "display_text" : "dws0505"
  } ],
  "facets" : [ {
    "typeName" : [ {
      "value" : "dataasset.Table",
      "id" : "dataasset.Table",
      "count" : 816,
      "aggregation" : 0.0,
      "children" : [ ]
    }, {
      "value" : "dlm.API",
      "id" : "dlm.API",
      "count" : 103,
      "aggregation" : 0.0,
      "children" : [ ]
    } ]
  }, {
    "base.DataAsset.sourceType" : [ {
      "value" : "dli",
      "id" : "dli",
      "count" : 1,
      "aggregation" : 0.0,
      "children" : [ ]
    }, {
      "value" : "hive",
      "id" : "hive",
      "count" : 1,
      "aggregation" : 0.0,
      "children" : [ ]
    } ]
  }, {
    "classifications.name" : [ {
      "value" : "01d1d582b14c4dfe8ebe53b15d88ffc2/c1549ae148144a37b219344892a5568f",
      "id" : "01d1d582b14c4dfe8ebe53b15d88ffc2/c1549ae148144a37b219344892a5568f",
      "count" : 2,
      "aggregation" : 0.0,
      "children" : [ ]
    }, {
      "value" : "01d1d582b14c4dfe8ebe53b15d88ffc2/e1893cd5baf34182b9d2e2728a02a2a8",
      "id" : "01d1d582b14c4dfe8ebe53b15d88ffc2/e1893cd5baf34182b9d2e2728a02a2a8",
      "count" : 2,
      "aggregation" : 0.0,
      "children" : [ ]
    } ]
  }, {
    "tags.name" : [ {
      "value" : "tag_testmLEi",
      "id" : "tag_testmLEi",
      "count" : 2,
      "aggregation" : 0.0,
      "children" : [ ]
    }, {
      "value" : "Mistaken deletion of personal data",
      "id" : "Mistaken deletion of personal data",
      "count" : 2,
      "aggregation" : 0.0,
      "children" : [ ]
    } ]
  }, {
    "securityLevel.name" : [ {
      "value" : "8a9480037c747038017c77363e510000",
      "id" : "8a9480037c747038017c77363e510000",
      "count" : 2,
      "aggregation" : 0.0,
      "children" : [ ]
    } ]
  }, {
    "workspaceId" : [ {
      "value" : "1b59d3c777ad4d619b89eeac4f3cce87",
      "id" : "1b59d3c777ad4d619b89eeac4f3cce87",
      "count" : 1234,
      "aggregation" : 0.0,
      "children" : [ ]
    } ]
  }, {
    "category.path" : [ {
      "value" : "ceshi_test",
      "id" : "eeb055e69c624311b6b9cfee89a4ec70/ceshi_test",
      "count" : 1234,
      "aggregation" : 0.0,
      "children" : [ ]
    }, {
      "value" : "Transport",
      "id" : "1b59d3c777ad4d619b89eeac4f3cce87/transportation",
      "count" : 1234,
      "aggregation" : 0.0,
      "children" : [ {
        "value" : "Trip record",
        "id" : "1b59d3c777ad4d619b89eeac4f3cce87/traffic/trip record",
        "count" : 1234,
        "aggregation" : 0.0,
        "children" : [ {
          "value" : "stroke_fact",
          "id" : "1b59d3c777ad4d619b89eeac4f3cce87/traffic/trip record/trip facts",
          "count" : 1234,
          "aggregation" : 0.0,
          "children" : [ ]
        } ]
      } ]
    } ]
  } ]
}

Status Codes

Status Code	Description
200	OK.
400	Bad request.
401	Unauthorized.
403	Forbidden.
404	Not found.
500	Internal server error.

Parent Topic: Data Map

Previous topic: User Behavior Analysis (Invitational Test)

Next topic: Creating or Modifying an Asset (Invitational Test)

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.