Glossary - List Glossaries

Obtenha todos os glossários registrados no Atlas.

GET {Endpoint}/catalog/api/atlas/v2/glossary
GET {Endpoint}/catalog/api/atlas/v2/glossary?limit={limit}&offset={offset}&sort={sort}&ignoreTermsAndCategories={ignoreTermsAndCategories}

Parâmetros de URI

Name In Required Type Description
Endpoint
path True
  • string

O ponto de extremidade do catálogo da sua conta do Purview. Exemplo: https://{accountName}.purview.azure.com

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

Name Type Description
200 OK

Uma matriz de glossários existentes que se ajustam aos critérios de pesquisa ou à lista vazia se nada corresponder.

Other Status Codes

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

Glossary_ListGlossaries

Sample Request

GET {Endpoint}/catalog/api/atlas/v2/glossary?limit=1&offset=0&sort=ASC

Sample Response

[
  {
    "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",
    "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

AtlasClassification

AtlasClassification

AtlasGlossary

AtlasGlossary

AtlasRelatedCategoryHeader

AtlasRelatedCategoryHeader

AtlasRelatedTermHeader

AtlasRelatedTermHeader

AtlasTermRelationshipStatus

AtlasTermRelationshipStatus

Attributes

Os atributos do struct.

ErrorResponse

Uma resposta de erro do serviço

SourceDetails

mais detalhes sobre informações de origem

Status

Status

TimeBoundary

TimeBoundary

AtlasClassification

AtlasClassification

Name Type Description
attributes

Os atributos do struct.

entityGuid
  • string

O GUID da entidade.

entityStatus

Status
Status da entidade – pode ser ativo ou excluído. Entidades excluídas não são removidas do Repositório Atlas.

lastModifiedTS
  • string

lastModifiedTS
ETag para controle de simultaneidade.

removePropagationsOnEntityDelete
  • boolean

Determina se as propagações serão removidas na exclusão de entidade.

source
  • string

indicar a origem que cria os detalhes de classificação

sourceDetails

mais detalhes sobre informações de origem

typeName
  • string

O nome do tipo.

validityPeriods

Uma matriz de limites de tempo que indica períodos de validade.

AtlasGlossary

AtlasGlossary

Name Type Description
categories

Uma matriz de categorias.

classifications

Uma matriz de classificações.

guid
  • string

O GUID do objeto.

language
  • string

A linguagem do glossário.

lastModifiedTS
  • string

lastModifiedTS
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

Uma matriz de cabeçalhos de termo relacionados.

usage
  • string

O uso do glossário.

AtlasRelatedCategoryHeader

AtlasRelatedCategoryHeader

Name Type Description
categoryGuid
  • string

O GUID da categoria.

description
  • string

A descrição do cabeçalho da categoria.

displayText
  • string

O texto de exibição.

parentCategoryGuid
  • string

O GUID da categoria pai.

relationGuid
  • string

O GUID da relação.

AtlasRelatedTermHeader

AtlasRelatedTermHeader

Name Type 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.

source
  • string

A origem do termo.

status

AtlasTermRelationshipStatus
O status da relação de termo.

steward
  • string

O administrador do termo.

termGuid
  • string

O GUID do termo.

AtlasTermRelationshipStatus

AtlasTermRelationshipStatus

Name Type Description
ACTIVE
  • string
DEPRECATED
  • string
DRAFT
  • string
OBSOLETE
  • string
OTHER
  • string

Attributes

Os atributos do struct.

Name Type Description

ErrorResponse

Uma resposta de erro do serviço

Name Type Description
errorCode
  • string

O código de erro.

errorMessage
  • string

A mensagem de erro.

requestId
  • string

A ID da solicitação.

SourceDetails

mais detalhes sobre informações de origem

Name Type Description

Status

Status

Name Type Description
ACTIVE
  • string
DELETED
  • string

TimeBoundary

TimeBoundary

Name Type Description
endTime
  • string

O limite de fim do tempo.

startTime
  • string

O limite de início da hora.

timeZone
  • string

O fuso horário do limite de tempo.