Azure.Analytics.Purview.Catalog (preview:2022-08-01)

2025/03/21 • 2 updated methods

Discovery_Query (updated)
Description :  Gets data using search.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Discovery_Query",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": [
            {
              "#name": "endorsement",
              "Type": {
                "new": "array",
                "old": "string"
              }
            }
          ]
        }
      }
    }
  }
}

⚼ Request

POST:  /search/query
{
searchRequest:
{
Description: An object specifying the search criteria. ,
Required: True ,
}
{
keywords:
{
Description: The keywords applied to all searchable fields. ,
Required: False ,
}
string ,
offset:
{
Description: The offset. The default value is 0. The maximum value is 100000. ,
Format: int32 ,
Required: False ,
}
integer ,
limit:
{
Description: The limit of the number of the search result. default value is 50; maximum value is 1000. ,
Format: int32 ,
Required: False ,
}
integer ,
orderby:
{
Description: The sort order of search results, can specify multiple fields. ,
Required: False ,
}
[
object ,
]
,
filter:
{
Description: The filter for the search. See examples for the usage of supported filters. ,
Required: False ,
}
object ,
facets:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
facet:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
sort:
{
Required: False ,
}
object ,
}
,
]
,
taxonomySetting:
{
Required: False ,
}
{
assetTypes:
{
Required: False ,
}
[
string ,
]
,
facet:
{
Description: The content of a search facet result item. ,
Required: False ,
}
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
facet:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
sort:
{
Required: False ,
}
object ,
}
,
}
,
}
,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
@search.count:
{
Description: The total number of search results (not the number of documents in a single page). ,
Format: int32 ,
Required: False ,
}
integer ,
@search.facets:
{
Description: A facet list that consists of index fields assetType ,classification, contactId, and label. When the facet is specified in the request, the value of the facet is returned as an element of @search.facets. ,
Required: False ,
}
{
entityType:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
assetType:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
classification:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
term:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
contactId:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
contactType:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
label:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
glossaryType:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
termStatus:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
termTemplate:
{
Required: False ,
}
[
{
count:
{
Description: The count of the facet item. ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The name of the facet item. ,
Required: False ,
}
string ,
}
,
]
,
}
,
value:
{
Required: False ,
}
[
{
@search.score:
{
Description: The search score calculated by the search engine. The results are ordered by search score by default. ,
Format: float ,
Required: False ,
}
number ,
@search.highlights:
{
Description: A highlight list that consists of index fields id ,qualifiedName, name, description, entityType. When the keyword appears in those fields, the value of the field, attached with emphasis mark, is returned as an element of @search.highlights. ,
Required: False ,
}
{
id:
{
Required: False ,
}
[
string ,
]
,
qualifiedName:
{
Required: False ,
}
[
string ,
]
,
name:
{
Required: False ,
}
[
string ,
]
,
description:
{
Required: False ,
}
[
string ,
]
,
entityType:
{
Required: False ,
}
[
string ,
]
,
}
,
objectType:
{
Description: The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term. ,
Required: False ,
}
string ,
createTime:
{
Description: The create time of the record. The Unix epoch format. ,
Format: int64 ,
Required: False ,
}
integer ,
updateTime:
{
Description: The last update time of the record. The Unix epoch format. ,
Format: int64 ,
Required: False ,
}
integer ,
id:
{
Description: The GUID of the record. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the record. ,
Required: False ,
}
string ,
entityType:
{
Description: The type name of the asset. ,
Required: False ,
}
string ,
description:
{
Description: The description of the asset. ,
Required: False ,
}
string ,
endorsement:
{
Description: The endorsement of the asset. ,
Required: False ,
}
[
string ,
]
,
owner:
{
Description: The owner of the record. This is an Atlas native attribute. ,
Required: False ,
}
string ,
classification:
{
Description: The classifications of the record. ,
Required: False ,
}
[
string ,
]
,
label:
{
Description: The labels of the asset. ,
Required: False ,
}
[
string ,
]
,
term:
{
Description: The terms assigned to the asset. ,
Required: False ,
}
[
{
name:
{
Description: The name of the term. ,
Required: False ,
}
string ,
glossaryName:
{
Description: The name of the glossary which contains the term. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
contact:
{
Description: The contacts of the asset. ,
Required: False ,
}
[
{
id:
{
Description: The GUID of the contact. ,
Required: False ,
}
string ,
info:
{
Description: The description of the contact. ,
Required: False ,
}
string ,
contactType:
{
Description: The type of the contact. It can be Expert or Owner for an entity. It can be Expert or Steward for a glossary term. ,
Required: False ,
}
string ,
}
,
]
,
assetType:
{
Description: The asset types of the asset. ,
Required: False ,
}
[
string ,
]
,
glossaryType:
{
Description: The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. ,
Required: False ,
}
string ,
glossary:
{
Description: The glossary name of the term. ,
Required: False ,
}
string ,
termStatus:
{
Description: The status of the term. ,
Required: False ,
}
string ,
termTemplate:
{
Description: The term template names used by the term. ,
Required: False ,
}
[
string ,
]
,
longDescription:
{
Description: The definition of the term. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}
Discovery_Suggest (updated)
Description :  Get search suggestions by query criteria.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Discovery_Suggest",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": [
            {
              "#name": "endorsement",
              "Type": {
                "new": "array",
                "old": "string"
              }
            }
          ]
        }
      }
    }
  }
}

⚼ Request

POST:  /search/suggest
{
suggestRequest:
{
Description: An object specifying the suggest criteria. ,
Required: True ,
}
{
keywords:
{
Description: The keywords applied to all fields that support suggest operation. It must be at least 1 character, and no more than 100 characters. In the index schema we defined a default suggester which lists all the supported fields and specifies a search mode. ,
Required: False ,
}
string ,
limit:
{
Description: The number of suggestions we hope to return. The default value is 5. The value must be a number between 1 and 100. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: The filter for the search. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Version of Purview APIs ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
@search.score:
{
Description: The search score calculated by the search engine. The results are ordered by search score by default. ,
Format: float ,
Required: False ,
}
number ,
@search.text:
{
Description: The target text that contains the keyword as prefix. The keyword is wrapped with emphasis mark. ,
Required: False ,
}
string ,
objectType:
{
Description: The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term. ,
Required: False ,
}
string ,
createTime:
{
Description: The create time of the record. The Unix epoch format. ,
Format: int64 ,
Required: False ,
}
integer ,
updateTime:
{
Description: The last update time of the record. The Unix epoch format. ,
Format: int64 ,
Required: False ,
}
integer ,
id:
{
Description: The GUID of the record. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record. ,
Required: False ,
}
string ,
qualifiedName:
{
Description: The qualified name of the record. ,
Required: False ,
}
string ,
entityType:
{
Description: The type name of the asset. ,
Required: False ,
}
string ,
description:
{
Description: The description of the asset. ,
Required: False ,
}
string ,
endorsement:
{
Description: The endorsement of the asset. ,
Required: False ,
}
[
string ,
]
,
owner:
{
Description: The owner of the record. This is an Atlas native attribute. ,
Required: False ,
}
string ,
classification:
{
Description: The classifications of the record. ,
Required: False ,
}
[
string ,
]
,
label:
{
Description: The labels of the asset. ,
Required: False ,
}
[
string ,
]
,
term:
{
Description: The terms assigned to the asset. ,
Required: False ,
}
[
{
name:
{
Description: The name of the term. ,
Required: False ,
}
string ,
glossaryName:
{
Description: The name of the glossary which contains the term. ,
Required: False ,
}
string ,
guid:
{
Description: The GUID of the term. ,
Required: False ,
}
string ,
}
,
]
,
contact:
{
Description: The contacts of the asset. ,
Required: False ,
}
[
{
id:
{
Description: The GUID of the contact. ,
Required: False ,
}
string ,
info:
{
Description: The description of the contact. ,
Required: False ,
}
string ,
contactType:
{
Description: The type of the contact. It can be Expert or Owner for an entity. It can be Expert or Steward for a glossary term. ,
Required: False ,
}
string ,
}
,
]
,
assetType:
{
Description: The asset types of the asset. ,
Required: False ,
}
[
string ,
]
,
glossaryType:
{
Description: The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory. ,
Required: False ,
}
string ,
glossary:
{
Description: The glossary name of the term. ,
Required: False ,
}
string ,
termStatus:
{
Description: The status of the term. ,
Required: False ,
}
string ,
termTemplate:
{
Description: The term template names used by the term. ,
Required: False ,
}
[
string ,
]
,
longDescription:
{
Description: The definition of the term. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
requestId:
{
Description: The request ID. ,
Required: False ,
}
string ,
errorCode:
{
Description: The error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message. ,
Required: False ,
}
string ,
}