Compartilhar via

Glossary - Get Detailed

  • Referência
Serviço:
Purview
Versão da API:
2023-09-01

Obtenha um glossário específico com informações detalhadas. Essa API não é recomendada.

Recomendamos buscar detalhes de 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/{glossaryId}/detailed
Com parâmetros opcionais: 
GET {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/detailed?api-version=2023-09-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpoint
 path True

string

glossaryId
 path True

string

O identificador global exclusivo 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

AtlasGlossaryExtInfo

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_GetDetailed

Solicitação de exemplo

GET {endpoint}/datamap/api/atlas/v2/glossary/c018ddaf-7c21-4b37-a838-dae5f110c3d8/detailed?api-version=2023-09-01

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",
  "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",
      "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2"
    },
    {
      "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
      "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0"
    },
    {
      "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
      "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d"
    }
  ],
  "termInfo": {
    "54688d39-b298-4104-9e80-f2a16f44aaea": {
      "guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
      "qualifiedName": "ExampleTerm1@Glossary",
      "name": "ExampleTerm1",
      "shortDescription": "Example Short Description",
      "longDescription": "Example Long Description",
      "lastModifiedTS": "2",
      "abbreviation": "T1",
      "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "createTime": 1606287247276,
      "updateTime": 1606290587593,
      "status": "Approved",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
      },
      "assignedEntities": [
        {
          "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0",
          "typeName": "hdfs_path",
          "entityStatus": "ACTIVE",
          "displayText": "1",
          "relationshipType": "AtlasGlossarySemanticAssignment",
          "relationshipGuid": "cf2e959c-05e6-4a9f-b106-b6475741c2ba",
          "relationshipStatus": "ACTIVE",
          "relationshipAttributes": {
            "typeName": "AtlasGlossarySemanticAssignment",
            "attributes": {
              "expression": "Example Expression",
              "createdBy": "ExampleCreator",
              "steward": "ExampleSteward",
              "confidence": 100,
              "description": "Example Description",
              "source": "Azure",
              "status": null
            }
          }
        }
      ],
      "categories": [
        {
          "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
          "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007"
        }
      ],
      "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"
        }
      ]
    },
    "952c7ba4-4c89-42d8-a05a-7d2161be7008": {
      "guid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "qualifiedName": "ExampleTerm2@Glossary",
      "name": "ExampleTerm2",
      "shortDescription": "Example Short Description",
      "lastModifiedTS": "1",
      "abbreviation": "T2",
      "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "createTime": 1606287312495,
      "updateTime": 1606287312495,
      "status": "Approved",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189"
      },
      "seeAlso": [
        {
          "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
          "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01",
          "displayText": "ExampleTerm1"
        }
      ],
      "synonyms": [
        {
          "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
          "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c",
          "displayText": "ExampleTerm1"
        }
      ],
      "resources": [
        {
          "displayName": "Example Display Name",
          "url": "Example Url"
        }
      ]
    }
  },
  "categoryInfo": {
    "ed7458f0-9463-48a5-b5c6-4f785fb34e12": {
      "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
      "qualifiedName": "ExampleCategory1.ExampleCategory2@Glossary",
      "name": "ExampleCategory1",
      "longDescription": "Example Long Description",
      "lastModifiedTS": "3",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0"
      },
      "parentCategory": {
        "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
        "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20"
      },
      "childrenCategories": [
        {
          "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e",
          "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f"
        }
      ],
      "terms": [
        {
          "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
          "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007",
          "displayText": "ExampleTerm1"
        }
      ]
    },
    "e47c4584-daca-4f9e-9092-194e04692c9a": {
      "guid": "e47c4584-daca-4f9e-9092-194e04692c9a",
      "qualifiedName": "ExampleCategory2@Glossary",
      "name": "ExampleCategory2",
      "lastModifiedTS": "1",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d"
      },
      "childrenCategories": [
        {
          "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
          "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20"
        }
      ]
    },
    "0d6766f6-f4b6-435b-bda2-d3edc358998e": {
      "guid": "0d6766f6-f4b6-435b-bda2-d3edc358998e",
      "qualifiedName": "ExampleCategory3.ExampleCategory1.ExampleCategory2@Glossary",
      "name": "ExampleCategory3",
      "lastModifiedTS": "2",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2"
      },
      "parentCategory": {
        "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
        "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f"
      }
    }
  }
}

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
AtlasGlossaryCategory

A categoria de glossário.
AtlasGlossaryExtInfo

As informações estendidas do glossário.
AtlasGlossaryHeader

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

O termo glossário.
AtlasRelatedCategoryHeader

O cabeçalho da categoria relacionada.
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.

AtlasGlossaryCategory

A categoria de glossário.

Nome Tipo Description
anchor

AtlasGlossaryHeader

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

AtlasRelatedCategoryHeader[]

Uma matriz de categorias filho.
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.
lastModifiedTS

string

ETag para controle de simultaneidade.
longDescription

string

A descrição da versão longa.
name

string

O nome do objeto glossário.
parentCategory

AtlasRelatedCategoryHeader

O cabeçalho da categoria relacionada.
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

O tempo de atualização do registro.
updatedBy

string

O usuário que atualizou o registro.

AtlasGlossaryExtInfo

As informações estendidas do glossário.

Nome Tipo Description
categories

AtlasRelatedCategoryHeader[]

Uma matriz de categorias.
categoryInfo

<string,  AtlasGlossaryCategory>

As informações da categoria do glossário.
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.
termInfo

<string,  AtlasGlossaryTerm>

As informações do termo glossário.
terms

AtlasRelatedTermHeader[]

Uma matriz de cabeçalhos de termo relacionados.
updateTime

integer

O tempo de atualização do registro.
updatedBy

string

O usuário que atualizou o registro.
usage

string

O uso do glossário.

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.

AtlasRelatedCategoryHeader

O cabeçalho da categoria relacionada.

Nome Tipo 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.

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 somente por meio de AtlasEntity, AtlasClassification.
relationshipGuid

string

O GUID da relação.
relationshipStatus

StatusAtlasRelationship

A enumeração da 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

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.