SearchResultValueOutput interface

Package:

@azure-rest/purview-datamap

The value item of the search result.

Properties

@search.highlights	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.
@search.score	The search score calculated by the search engine. The results are ordered by search score by default.
assetType	The asset types of the asset.
classification	The classifications of the record.
contact	The contacts of the asset.
createTime	The create time of the record. The Unix epoch format.
description	The description of the asset.
endorsement	The endorsement of the asset.
entityType	The type name of the asset.
glossary	The glossary name of the term.
glossaryType	The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory.
id	The GUID of the record.
label	The labels of the asset.
longDescription	The definition of the term.
name	The name of the record.
objectType	The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term.
owner	The owner of the record.
qualifiedName	The qualified name of the record.
term	The terms assigned to the asset.
termStatus	The status of the term.
termTemplate	The term template names used by the term.
updateTime	The last update time of the record. The Unix epoch format.

Property Details

@search.highlights

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.

@search.highlights?: SearchHighlightsOutput

Property Value

SearchHighlightsOutput

@search.score

The search score calculated by the search engine. The results are ordered by search score by default.

@search.score?: number

Property Value

number

assetType

The asset types of the asset.

assetType?: string[]

Property Value

string[]

classification

The classifications of the record.

classification?: string[]

Property Value

string[]

contact

The contacts of the asset.

contact?: ContactSearchResultValueOutput[]

Property Value

ContactSearchResultValueOutput[]

createTime

The create time of the record. The Unix epoch format.

createTime?: number

Property Value

number

description

The description of the asset.

description?: string

Property Value

string

endorsement

The endorsement of the asset.

endorsement?: string[]

Property Value

string[]

entityType

The type name of the asset.

entityType?: string

Property Value

string

glossary

The glossary name of the term.

glossary?: string

Property Value

string

glossaryType

The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory.

glossaryType?: string

Property Value

string

id

The GUID of the record.

id?: string

Property Value

string

label

The labels of the asset.

label?: string[]

Property Value

string[]

longDescription

The definition of the term.

longDescription?: string

Property Value

string

name

The name of the record.

name?: string

Property Value

string

objectType

The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term.

objectType?: string

Property Value

string

owner

The owner of the record.

owner?: string

Property Value

string

qualifiedName

The qualified name of the record.

qualifiedName?: string

Property Value

string

term

The terms assigned to the asset.

term?: TermSearchResultValueOutput[]

Property Value

TermSearchResultValueOutput[]

termStatus

The status of the term.

termStatus?: string

Property Value

string

termTemplate

The term template names used by the term.

termTemplate?: string[]

Property Value

string[]

updateTime

The last update time of the record. The Unix epoch format.

updateTime?: number

Property Value

number