Glossary - Get Term

Referência

Serviço:: Purview

Versão da API:: 2023-09-01

Obtenha um termo de glossário específico por seu GUID.

GET {endpoint}/datamap/api/atlas/v2/glossary/term/{termId}

Com parâmetros opcionais:

GET {endpoint}/datamap/api/atlas/v2/glossary/term/{termId}?api-version=2023-09-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string
termId	path	True	string	O identificador global exclusivo para o termo do glossário.
api-version	query		string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	AtlasGlossaryTerm	A solicitação foi bem-sucedida.
Other Status Codes	AtlasErrorResponse	Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
https://purview.azure.net/.default

Exemplos

Glossary_GetTerm

Glossary_GetTermWithoutAssets

Glossary_GetTerm

Solicitação de exemplo

HTTP

GET {endpoint}/datamap/api/atlas/v2/glossary/term/54688d39-b298-4104-9e80-f2a16f44aaea?api-version=2023-09-01

Resposta de exemplo

Código de status:: 200

{
  "guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
  "qualifiedName": "ExampleTerm1@Glossary",
  "name": "ExampleTerm1",
  "shortDescription": "Example Short Description",
  "lastModifiedTS": "1",
  "abbreviation": "T1",
  "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "createTime": 1606287247276,
  "updateTime": 1606287247276,
  "status": "Approved",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
  },
  "seeAlso": [
    {
      "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01",
      "displayText": "ExampleTerm2"
    }
  ],
  "synonyms": [
    {
      "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c",
      "displayText": "ExampleTerm2"
    }
  ],
  "contacts": {
    "Expert": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Expert Info"
      }
    ],
    "Steward": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Steward Info"
      }
    ]
  },
  "resources": [
    {
      "displayName": "Example Display Name",
      "url": "Example Url"
    }
  ],
  "assignedEntities": [
    {
      "guid": "7e255139-b654-4c8d-a4bd-fbb5a243e83f",
      "typeName": "azure_datalake_gen2_path",
      "entityStatus": "ACTIVE",
      "displayText": "moviesDB.csv",
      "relationshipType": "AtlasGlossarySemanticAssignment",
      "relationshipGuid": "ace36560-6259-4e7f-9214-3850b2af0a86",
      "relationshipStatus": "ACTIVE",
      "relationshipAttributes": {
        "typeName": "AtlasGlossarySemanticAssignment",
        "attributes": {
          "expression": null,
          "createdBy": null,
          "steward": null,
          "confidence": null,
          "description": null,
          "source": null,
          "status": null
        }
      }
    }
  ]
}

Glossary_GetTermWithoutAssets

Solicitação de exemplo

HTTP

GET {endpoint}/datamap/api/atlas/v2/glossary/term/54688d39-b298-4104-9e80-f2a16f44aaea?api-version=2023-09-01

Resposta de exemplo

Código de status:: 200

{
  "guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
  "qualifiedName": "ExampleTerm1@Glossary",
  "name": "ExampleTerm1",
  "shortDescription": "Example Short Description",
  "lastModifiedTS": "1",
  "abbreviation": "T1",
  "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "createTime": 1606287247276,
  "updateTime": 1606287247276,
  "status": "Approved",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
  },
  "seeAlso": [
    {
      "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01",
      "displayText": "ExampleTerm2"
    }
  ],
  "synonyms": [
    {
      "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c",
      "displayText": "ExampleTerm2"
    }
  ],
  "contacts": {
    "Expert": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Expert Info"
      }
    ],
    "Steward": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Steward Info"
      }
    ]
  },
  "resources": [
    {
      "displayName": "Example Display Name",
      "url": "Example Url"
    }
  ]
}

Definições

Nome	Description
AtlasClassification	Uma instância de uma classificação; ele não tem uma identidade, esse objeto só existe quando associado a uma entidade.
AtlasErrorResponse	Uma resposta de erro do serviço
AtlasGlossaryHeader	O cabeçalho do glossário com informações básicas.
AtlasGlossaryTerm	O termo glossário.
AtlasRelatedObjectId	Referência a uma instância de objeto do tipo AtlasEntity usada em valores de atributo de relação
AtlasRelatedTermHeader	O cabeçalho do termo relacionado.
AtlasStruct	Captura detalhes do conteúdo do struct. Não instanciado diretamente, usado somente por meio de AtlasEntity, AtlasClassification.
AtlasTermCategorizationHeader	As informações básicas para categorização de termos.
AtlasTermRelationshipStatus	Status da relação de termo atlas
EntityStatus	Status – pode ser ativo ou excluído
PurviewObjectId	PurviewObjectId
ResourceLink	ResourceLink
StatusAtlasRelationship	Status da relação atlas
TermStatus	Status do termo
TimeBoundary	Captura detalhes de limite de tempo

AtlasClassification

Uma instância de uma classificação; ele não tem uma identidade, esse objeto só existe quando associado a uma entidade.

Nome	Tipo	Description
attributes		Os atributos do struct.
entityGuid	string	O GUID da entidade.
entityStatus	EntityStatus	Status da entidade – pode estar ativo ou excluído. Entidades excluídas não são removidas.
lastModifiedTS	string	ETag para controle de simultaneidade.
removePropagationsOnEntityDelete	boolean	Determina se as propagações serão removidas na exclusão de entidade.
typeName	string	O nome do tipo.
validityPeriods	TimeBoundary[]	Uma matriz de limites de tempo que indica períodos de validade.

AtlasErrorResponse

Uma resposta de erro do serviço

Nome	Tipo	Description
errorCode	string	O código de erro.
errorMessage	string	A mensagem de erro.
requestId	string	A ID da solicitação.

AtlasGlossaryHeader

O cabeçalho do glossário com informações básicas.

Nome	Tipo	Description
displayText	string	O texto de exibição.
glossaryGuid	string	O GUID do glossário.
relationGuid	string	O GUID da relação.

AtlasGlossaryTerm

O termo glossário.

Nome	Tipo	Description
abbreviation	string	A abreviação do termo.
anchor	AtlasGlossaryHeader	O cabeçalho do glossário com informações básicas.
antonyms	AtlasRelatedTermHeader[]	Uma matriz de cabeçalhos de termo relacionados como antônimos.
assignedEntities	AtlasRelatedObjectId[]	Uma matriz de IDs de objeto relacionadas.
attributes	object	Os atributos personalizados do termo, que é cadeia de caracteres de mapa<, cadeia de caracteres de mapa<, objeto>>. A chave do primeiro mapa de camadas é o nome do modelo de termo.
categories	AtlasTermCategorizationHeader[]	Uma matriz de cabeçalhos de categorização de termos.
classifications	AtlasClassification[]	Uma matriz de classificações.
classifies	AtlasRelatedTermHeader[]	Uma matriz de cabeçalhos de termo relacionados.
contacts	object	O dicionário de contatos para termos. A chave pode ser Expert ou Steward.
createTime	integer	A hora criada do registro.
createdBy	string	O usuário que criou o registro.
examples	string[]	Uma matriz de exemplos.
guid	string	O GUID do objeto.
hierarchyInfo	PurviewObjectId[]	As informações de hierarquia do termo.
isA	AtlasRelatedTermHeader[]	Uma matriz de cabeçalhos de termo relacionados que indica a relação is-a.
lastModifiedTS	string	ETag para controle de simultaneidade.
longDescription	string	A descrição da versão longa.
name	string	O nome do objeto glossário.
nickName	string	O nome nick do termo.
preferredTerms	AtlasRelatedTermHeader[]	Uma matriz de cabeçalhos de termo relacionados preferenciais.
preferredToTerms	AtlasRelatedTermHeader[]	Uma matriz de cabeçalhos de termo relacionados que são preferenciais.
qualifiedName	string	O nome qualificado do objeto glossário.
replacedBy	AtlasRelatedTermHeader[]	Uma matriz de cabeçalhos de termo relacionados que são substituídos por.
replacementTerms	AtlasRelatedTermHeader[]	Uma matriz de cabeçalhos de termo relacionados para substituição.
resources	ResourceLink[]	Uma matriz de link de recurso para termo
seeAlso	AtlasRelatedTermHeader[]	Uma matriz de cabeçalhos de termo relacionados para ver também.
shortDescription	string	A versão curta da descrição.
status	TermStatus	Status do AtlasGlossaryTerm
synonyms	AtlasRelatedTermHeader[]	Uma matriz de cabeçalhos de termo relacionados como sinônimos.
templateName	TemplateName[]	O nome do modelo.
translatedTerms	AtlasRelatedTermHeader[]	Uma matriz de cabeçalhos de termo relacionados traduzidos.
translationTerms	AtlasRelatedTermHeader[]	Uma matriz de cabeçalhos de termo relacionados para tradução.
updateTime	integer	O tempo de atualização do registro.
updatedBy	string	O usuário que atualizou o registro.
usage	string	O uso do termo.
validValues	AtlasRelatedTermHeader[]	Uma matriz de cabeçalhos de termo relacionados como valores válidos.
validValuesFor	AtlasRelatedTermHeader[]	Uma matriz de cabeçalhos de termo relacionados como valores válidos para outros registros.

AtlasRelatedObjectId

Referência a uma instância de objeto do tipo AtlasEntity usada em valores de atributo de relação

Nome	Tipo	Description
displayText	string	O texto de exibição.
entityStatus	EntityStatus	Status da entidade – pode estar ativo ou excluído. Entidades excluídas não são removidas.
guid	string	O GUID do objeto.
relationshipAttributes	AtlasStruct	Captura detalhes do conteúdo do struct. Não instanciado diretamente, usado apenas por meio de AtlasEntity, AtlasClassification.
relationshipGuid	string	O GUID da relação.
relationshipStatus	StatusAtlasRelationship	A enumeração de relação status.
relationshipType	string	Tipo de relação
typeName	string	O nome do tipo.
uniqueAttributes		Os atributos exclusivos do objeto.

AtlasRelatedTermHeader

O cabeçalho do termo relacionado.

Nome	Tipo	Description
description	string	A descrição do termo relacionado.
displayText	string	O texto de exibição.
expression	string	A expressão do termo .
relationGuid	string	O GUID da relação.
status	AtlasTermRelationshipStatus	O status da relação de termos.
steward	string	O administrador do termo.
termGuid	string	O GUID do termo.

AtlasStruct

Captura detalhes do conteúdo do struct. Não instanciado diretamente, usado somente por meio de AtlasEntity, AtlasClassification.

Nome	Tipo	Description
attributes		Os atributos do struct.
lastModifiedTS	string	ETag para controle de simultaneidade.
typeName	string	O nome do tipo.

AtlasTermCategorizationHeader

As informações básicas para categorização de termos.

Nome	Tipo	Description
categoryGuid	string	O GUID da categoria.
description	string	A descrição do registro.
displayText	string	O texto de exibição.
relationGuid	string	O GUID da relação.
status	AtlasTermRelationshipStatus	O status da relação de termo.

AtlasTermRelationshipStatus

Status da relação de termo atlas

Nome	Tipo	Description
ACTIVE	string	ativo
DEPRECATED	string	preterido
DRAFT	string	Projecto
OBSOLETE	string	obsoleto
OTHER	string	other

EntityStatus

Status – pode ser ativo ou excluído

Nome	Tipo	Description
ACTIVE	string	O status está ativo.
DELETED	string	O status é excluído.

PurviewObjectId

Nome	Tipo	Description
displayText	string	Exibir texto
guid	string	O GUID do objeto.
itemPath	string	Caminho de item
name	string	Nome
properties		Dicionário de
resourceId	string	ID do recurso
typeName	string	O nome do tipo.
uniqueAttributes		Os atributos exclusivos do objeto.

ResourceLink

Nome	Tipo	Description
displayName	string	Nome de exibição para URL.
url	string	URL da Web. http ou https

StatusAtlasRelationship

Status da relação atlas

Nome	Tipo	Description
ACTIVE	string	ativo
DELETED	string	deleted

TermStatus

Status do termo

Nome	Tipo	Description
Alert	string	alerta
Approved	string	Aprovado
Draft	string	Projecto
Expired	string	Expirado

TimeBoundary

Captura detalhes de limite de tempo

Nome	Tipo	Description
endTime	string	O fim do limite de tempo.
startTime	string	O início do limite de tempo.
timeZone	string	O fuso horário do limite de tempo.

Compartilhar via

Glossary - Get Term

Parâmetros de URI

Respostas

Segurança

OAuth2Auth

Escopos

Exemplos

Glossary_GetTerm

Solicitação de exemplo

Resposta de exemplo

Glossary_GetTermWithoutAssets

Solicitação de exemplo

Resposta de exemplo

Definições

AtlasClassification

AtlasErrorResponse

AtlasGlossaryHeader

AtlasGlossaryTerm

AtlasRelatedObjectId

AtlasRelatedTermHeader

AtlasStruct

AtlasTermCategorizationHeader

AtlasTermRelationshipStatus

EntityStatus

PurviewObjectId

ResourceLink

StatusAtlasRelationship

TermStatus

TimeBoundary

Recursos adicionais