Glossary - List

Referência

Serviço:: Purview

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

Pegue todos os glossários. É recomendável usar limite/deslocamento para obter o resultado da paginação. Recomendamos usar 'ignoreTermsAndCategories=true' e buscar termos/categorias separadamente usando 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' e 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.

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

Com parâmetros opcionais:

GET {endpoint}/datamap/api/atlas/v2/glossary?api-version=2023-09-01&limit={limit}&offset={offset}&sort={sort}&ignoreTermsAndCategories={ignoreTermsAndCategories}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string
api-version	query		string	A versão da API a ser usada para esta operação.
ignoreTermsAndCategories	query		boolean	Se ignorar termos e categorias
limit	query		integer int32	O tamanho da página – por padrão, não há paginação.
offset	query		integer int32	O deslocamento para fins de paginação.
sort	query		string	A ordem de classificação, ASC (padrão) ou DESC.

Respostas

Nome	Tipo	Description
200 OK	AtlasGlossary[]	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_List

Solicitação de exemplo

HTTP

GET {endpoint}/datamap/api/atlas/v2/glossary?api-version=2023-09-01&limit=1&offset=0&sort=ASC

Resposta de exemplo

Código de status:: 200

[
  {
    "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "qualifiedName": "Glossary",
    "name": "Glossary",
    "shortDescription": "Example Short Description",
    "longDescription": "Example Long Description",
    "lastModifiedTS": "1",
    "language": "en",
    "usage": "Example Glossary",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "createTime": 1672892675688,
    "updateTime": 1672892675688,
    "terms": [
      {
        "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
        "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0",
        "displayText": "ExampleTerm1"
      },
      {
        "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
        "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189",
        "displayText": "ExampleTerm2"
      }
    ],
    "categories": [
      {
        "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e",
        "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
        "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2",
        "displayText": "ExampleCategory3"
      },
      {
        "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
        "parentCategoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
        "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0",
        "displayText": "ExampleCategory1"
      },
      {
        "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
        "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d",
        "displayText": "ExampleCategory2"
      }
    ]
  }
]

Definições

Nome	Description
AtlasClassification	Uma instância de uma classificação; ele não tem uma identidade, esse objeto existe somente quando associado a uma entidade.
AtlasErrorResponse	Uma resposta de erro do serviço
AtlasGlossary	O objeto glossário.
AtlasRelatedCategoryHeader	O cabeçalho da categoria relacionada.
AtlasRelatedTermHeader	O cabeçalho do termo relacionado.
AtlasTermRelationshipStatus	Status da relação de termo atlas
EntityStatus	Status – pode ser ativo ou excluído
TimeBoundary	Captura detalhes de limite de tempo

AtlasClassification

Uma instância de uma classificação; ele não tem uma identidade, esse objeto existe somente 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 da 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.

AtlasGlossary

O objeto glossário.

Nome	Tipo	Description
categories	AtlasRelatedCategoryHeader[]	Uma matriz de categorias.
classifications	AtlasClassification[]	Uma matriz de classificações.
createTime	integer	A hora criada do registro.
createdBy	string	O usuário que criou o registro.
guid	string	O GUID do objeto.
language	string	A linguagem do glossário.
lastModifiedTS	string	ETag para controle de simultaneidade.
longDescription	string	A descrição da versão longa.
name	string	O nome do objeto glossário.
qualifiedName	string	O nome qualificado do objeto glossário.
shortDescription	string	A versão curta da descrição.
terms	AtlasRelatedTermHeader[]	Uma matriz de cabeçalhos de termo relacionados.
updateTime	integer	A hora de atualização do registro.
updatedBy	string	O usuário que atualizou o registro.
usage	string	O uso do glossário.

AtlasRelatedCategoryHeader

O cabeçalho da categoria relacionada.

Nome	Tipo	Description
categoryGuid	string	O GUID da categoria.
description	string	A descrição do cabeçalho de categoria.
displayText	string	O texto de exibição.
parentCategoryGuid	string	O GUID da categoria pai.
relationGuid	string	O GUID da relação.

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 termo.
steward	string	O administrador do termo.
termGuid	string	O GUID do termo.

AtlasTermRelationshipStatus

Status da relação de termo atlas

Nome	Tipo	Description
ACTIVE	string	ativo
DEPRECATED	string	deprecado
DRAFT	string	rascunho
OBSOLETE	string	obsoleto
OTHER	string	outro

EntityStatus

Status – pode ser ativo ou excluído

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

TimeBoundary

Captura detalhes de limite de tempo

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

Compartilhar via