This API is used to query an unrelated table.

Function

If no lineage relationship table is queried, at least one of type_names, classification, type_names, connection_names and query must be specified.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/lineage/search/unrelated/table

**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
attributes	No	Object	Attribute
classifications	No	Array of strings	Grouping mode.
connection_names	No	Array of strings	Data connection.
exclude_classifications	No	Boolean	Indicates whether to exclude a category.
exclude_security_levels	No	Boolean	Indicates whether to exclude the security level.
exclude_tags	No	Boolean	Whether to exclude tags
include_classification_attributes	No	Boolean	Contains classification attributes.
include_sub_classifications	No	Boolean	Contains sub-categories.
limit	No	Integer	Specifies the maximum number of records on each page. By default, all records are queried.
offset	No	Integer	Specifies the offset. By default, all records are queried.
order	No	String	Enumerates the sorting types.
query	No	String	Query parameters.
search_name_and_description	No	Boolean	Indicates whether to search by name and description.
security_levels	No	Array of strings	Security Level List.
term_names	No	Array of strings	List of tags
type_names	No	Array of strings	Indicates the type list.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
attributes	AttributeSearchResult object	Attributes
classification	String	Grouping mode.
count	Integer	Total number of results.
entities	Array of AtlasEntityHeader objects	Asset information.
full_text_result	Array of AtlasFullTextResult objects	Full text results.
query_text	String	Query content.
query_type	String	Query type. The value can be DSL, FULL_TEXT, GREMLIN, BASIC, ATTRIBUTE, RELATIONSHIP or ADVANCED.
referred_entities	Object	Map(String, AtlasEntityHeader). key: guid; value: asset information AtlasEntityHeader.
scroll_id	String	Scroll bar ID.
search_parameters	Object	Parameter
type	String	Type

**Table 5** AttributeSearchResult
Parameter	Type	Description
name	Array of strings	Specifies names.
values	Array of objects	List of tag values

**Table 6** AtlasEntityHeader
Parameter	Type	Description
type_name	String	Type name.
guid	String	Asset GUID.
name	String	Name
display_text	String	recommendation
status	String	Status
classification_names	Array of strings	Category name list.
classifications	Array of AtlasClassificationInfo objects	Category information.
meaning_names	Array of strings	Tag names
meanings	Array of TermAssignmentHeader objects	Associate a task.
children	Object	Entity map Map(String, AtlasEntityHeader) The key is the GUID, and value is the asset information.
attributes	Object	Entity map, which is Map (String, Object) The key is the attribute name, and value is the attribute value.

**Table 7** AtlasFullTextResult
Parameter	Type	Description
entity	AtlasEntityHeader object	Asset information.
score	Number	Sub-option code.

**Table 8** AtlasClassificationInfo
Parameter	Type	Description
entity_guid	String	Asset GUID.
propagate	Boolean	Indicates whether to propagate.
validity_periods	Array of TimeBoundary objects	Time information.
type_name	String	Type name.
attributes	Object	Entity map Map(String, Object). key: attribute name; value: attribute value.

**Table 9** TimeBoundary
Parameter	Type	Description
start_time	String	Start time.
end_time	String	End time.
time_zone	String	Time zone.

**Table 10** TermAssignmentHeader
Parameter	Type	Description
confidence	Integer	Trust ID.
steward	String	Administrator
source	String	Source.
status	String	Enumerated values: DISCOVERED, PROPOSED, IMPORTED, VALIDATED, DEPRECATED, OBSOLETE and OTHER.
create_user	String	Creator
expression	String	Expression.
display_text	String	Display information
term_guid	String	Tag GUID
relation_guid	String	Associated GUID

Status code: 400

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

Status code: 401

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

Status code: 403

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

Status code: 404

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

Example Requests

{
  "attributes" : {
    "database" : [ "database" ],
    "classifications" : [ ],
    "connection_names" : [ ],
    "exclude_classifications" : false,
    "exclude_security_levels" : false,
    "exclude_tags" : false,
    "include_classification_attributes" : false,
    "include_sub_classifications" : false,
    "limit" : 10,
    "offset" : 0,
    "order" : "incr",
    "query" : "wk_02",
    "search_name_and_description" : true,
    "security_levels" : [ ],
    "term_names" : [ ],
    "type_names" : [ ]
  }
}

Example Responses

Status code: 200

OK.

{
  "attributes" : null,
  "classification" : null,
  "count" : 78,
  "entities" : [ {
    "attributes" : {
      "securityLevel" : null,
      "owner" : "DA_test",
      "comments" : null,
      "createTime" : 1674961143000,
      "qualifiedName" : "wk.hive_02@hive.192.168.0.96-mrs_3x_autotest_do_not_del.0833a5737480d53b2f25c010dc1a7b88-workspace -b88c445407b24283aa949f9833a38fd8",
      "connectionQName" : "hive@192.168.0.96-mrs_3x_autotest_do_not_del.0833a5737480d53b2f25c010dc1a7b88-workspace -b88c445407b24283aa949f9833a38fd8",
      "name" : "hive_02",
      "description" : null,
      "connectionType" : "hive"
    },
    "children" : null,
    "classification_names" : [ ],
    "classifications" : null,
    "display_text" : null,
    "guid" : "9915ee1e-3803-4f4d-86b2-ee5dfadc0d46",
    "meaning_names" : [ ],
    "meanings" : [ ],
    "name" : null,
    "status" : "ACTIVE",
    "type_name" : "hive_table"
  } ],
  "full_text_result" : null,
  "query_text" : "",
  "query_type" : "ADVANCED",
  "referred_entities" : null,
  "scroll_id" : null,
  "search_parameters" : null,
  "type" : null
}

Status Codes

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

Parent Topic: Lineage Information

Previous topic: Lineage Information

Next topic: Lineage query

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.