Condividi tramite

Glossary - Get Detailed

  • Riferimento
Servizio:
Purview
Versione API:
2023-09-01

Ottenere un glossario specifico con informazioni dettagliate. Questa API non è consigliabile.

Consiglia di recuperare i dettagli di termini/categorie separatamente usando

GET /datamap/api/atlas/v2/glossario/{glossarioId}/termini e

GET /datamap/api/atlas/v2/glossario/{glossarioId}/categories.

GET {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/detailed
Con parametri facoltativi: 
GET {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/detailed?api-version=2023-09-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
 path True

string

glossaryId
 path True

string

Identificatore univoco globale per il glossario.
api-version
 query

string

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

AtlasGlossaryExtInfo

La richiesta ha avuto esito positivo.
Other Status Codes

AtlasErrorResponse

Risposta di errore imprevista.

Sicurezza

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

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

Esempio

Glossary_GetDetailed

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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"
      }
    }
  }
}

Definizioni

Nome Descrizione
AtlasClassification

Istanza di una classificazione; non ha un'identità, questo oggetto esiste solo quando associato a un'entità.
AtlasErrorResponse

Risposta di errore dal servizio
AtlasGlossaryCategory

Categoria di glossario.
AtlasGlossaryExtInfo

Informazioni estese del glossario.
AtlasGlossaryHeader

Intestazione di glossario con informazioni di base.
AtlasGlossaryTerm

Termine glossario.
AtlasRelatedCategoryHeader

Intestazione della categoria correlata.
AtlasRelatedObjectId

Riferimento a un'istanza di oggetto del tipo AtlasEntity usato nei valori dell'attributo di relazione
AtlasRelatedTermHeader

Intestazione del termine correlato.
AtlasStruct

Acquisisce i dettagli del contenuto dello struct. Non creata direttamente un'istanza, usata solo tramite AtlasEntity, AtlasClassification.
AtlasTermCategorizationHeader

Informazioni di base per la categorizzazione del termine.
AtlasTermRelationshipStatus

Stato per la relazione del termine atlas
EntityStatus

Stato : può essere attivo o eliminato
PurviewObjectId

PurviewObjectId
ResourceLink

ResourceLink
StatusAtlasRelationship

Stato per la relazione atlas
TermStatus

Stato per il termine
TimeBoundary

Acquisisce i dettagli del limite temporale

AtlasClassification

Istanza di una classificazione; non ha un'identità, questo oggetto esiste solo quando associato a un'entità.

Nome Tipo Descrizione
attributes

Attributi dello struct.
entityGuid

string

GUID dell'entità.
entityStatus

EntityStatus

Stato dell'entità: può essere attivo o eliminato. Le entità eliminate non vengono rimosse.
lastModifiedTS

string

ETag per il controllo di concorrenza.
removePropagationsOnEntityDelete

boolean

Determina se le propagazioni verranno rimosse per l'eliminazione dell'entità.
typeName

string

Nome del tipo.
validityPeriods

TimeBoundary[]

Matrice di limiti temporali che indicano periodi di validità.

AtlasErrorResponse

Risposta di errore dal servizio

Nome Tipo Descrizione
errorCode

string

Codice di errore.
errorMessage

string

Messaggio di errore.
requestId

string

ID richiesta.

AtlasGlossaryCategory

Categoria di glossario.

Nome Tipo Descrizione
anchor

AtlasGlossaryHeader

Intestazione di glossario con informazioni di base.
childrenCategories

AtlasRelatedCategoryHeader[]

Matrice di categorie figlio.
classifications

AtlasClassification[]

Matrice di classificazioni.
createTime

integer

Ora creata del record.
createdBy

string

Utente che ha creato il record.
guid

string

GUID dell'oggetto .
lastModifiedTS

string

ETag per il controllo di concorrenza.
longDescription

string

Descrizione della versione lunga.
name

string

Nome dell'oggetto glossario.
parentCategory

AtlasRelatedCategoryHeader

Intestazione della categoria correlata.
qualifiedName

string

Nome qualificato dell'oggetto glossario.
shortDescription

string

Versione breve della descrizione.
terms

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate.
updateTime

integer

Ora di aggiornamento del record.
updatedBy

string

Utente che ha aggiornato il record.

AtlasGlossaryExtInfo

Informazioni estese del glossario.

Nome Tipo Descrizione
categories

AtlasRelatedCategoryHeader[]

Matrice di categorie.
categoryInfo

<string,  AtlasGlossaryCategory>

Informazioni sulla categoria di glossario.
classifications

AtlasClassification[]

Matrice di classificazioni.
createTime

integer

Ora creata del record.
createdBy

string

Utente che ha creato il record.
guid

string

GUID dell'oggetto .
language

string

Lingua del glossario.
lastModifiedTS

string

ETag per il controllo di concorrenza.
longDescription

string

Descrizione della versione lunga.
name

string

Nome dell'oggetto glossario.
qualifiedName

string

Nome qualificato dell'oggetto glossario.
shortDescription

string

Versione breve della descrizione.
termInfo

<string,  AtlasGlossaryTerm>

Informazioni sul glossario.
terms

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate.
updateTime

integer

Ora di aggiornamento del record.
updatedBy

string

Utente che ha aggiornato il record.
usage

string

Utilizzo del glossario.

AtlasGlossaryHeader

Intestazione di glossario con informazioni di base.

Nome Tipo Descrizione
displayText

string

Testo visualizzato.
glossaryGuid

string

GUID del glossario.
relationGuid

string

GUID della relazione.

AtlasGlossaryTerm

Termine glossario.

Nome Tipo Descrizione
abbreviation

string

Abbreviazione del termine.
anchor

AtlasGlossaryHeader

Intestazione di glossario con informazioni di base.
antonyms

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate come antonyms.
assignedEntities

AtlasRelatedObjectId[]

Matrice di ID oggetto correlati.
attributes

object

Attributi personalizzati del termine, ovvero stringa mappa<, stringa mappa<, oggetto>>. La chiave della prima mappa di livello è il nome del modello di termine.
categories

AtlasTermCategorizationHeader[]

Matrice di intestazioni di categorizzazione termini.
classifications

AtlasClassification[]

Matrice di classificazioni.
classifies

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate.
contacts

object

Dizionario dei contatti per i termini. La chiave potrebbe essere Expert o Steward.
createTime

integer

Ora creata del record.
createdBy

string

Utente che ha creato il record.
examples

string[]

Matrice di esempi.
guid

string

GUID dell'oggetto .
hierarchyInfo

PurviewObjectId[]

Informazioni sulla gerarchia del termine.
isA

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate che indicano la relazione is-a.
lastModifiedTS

string

ETag per il controllo di concorrenza.
longDescription

string

Descrizione della versione lunga.
name

string

Nome dell'oggetto glossario.
nickName

string

Nome nick del termine.
preferredTerms

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate preferite.
preferredToTerms

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate che sono preferite.
qualifiedName

string

Nome qualificato dell'oggetto glossario.
replacedBy

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate sostituite da .
replacementTerms

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate per la sostituzione.
resources

ResourceLink[]

Matrice di collegamento alla risorsa per il termine
seeAlso

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate per vedere anche.
shortDescription

string

Versione breve della descrizione.
status

TermStatus

Stato dell'Atlas GlossariaryTerm
synonyms

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate come sinonimi.
templateName

TemplateName[]

Nome del modello.
translatedTerms

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate tradotte.
translationTerms

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate per la traduzione.
updateTime

integer

Ora di aggiornamento del record.
updatedBy

string

Utente che ha aggiornato il record.
usage

string

Utilizzo del termine.
validValues

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate come valori validi.
validValuesFor

AtlasRelatedTermHeader[]

Matrice di intestazioni di termini correlate come valori validi per altri record.

AtlasRelatedCategoryHeader

Intestazione della categoria correlata.

Nome Tipo Descrizione
categoryGuid

string

GUID della categoria.
description

string

Descrizione dell'intestazione della categoria.
displayText

string

Testo visualizzato.
parentCategoryGuid

string

GUID della categoria padre.
relationGuid

string

GUID della relazione.

AtlasRelatedObjectId

Riferimento a un'istanza di oggetto del tipo AtlasEntity usato nei valori dell'attributo di relazione

Nome Tipo Descrizione
displayText

string

Testo visualizzato.
entityStatus

EntityStatus

Stato dell'entità: può essere attivo o eliminato. Le entità eliminate non vengono rimosse.
guid

string

GUID dell'oggetto .
relationshipAttributes

AtlasStruct

Acquisisce i dettagli del contenuto dello struct. Non creata direttamente un'istanza, usata solo tramite AtlasEntity, AtlasClassification.
relationshipGuid

string

GUID della relazione.
relationshipStatus

StatusAtlasRelationship

Enumerazione dello stato della relazione.
relationshipType

string

Tipo di relazione
typeName

string

Nome del tipo.
uniqueAttributes

Attributi univoci dell'oggetto.

AtlasRelatedTermHeader

Intestazione del termine correlato.

Nome Tipo Descrizione
description

string

Descrizione del termine correlato.
displayText

string

Testo visualizzato.
expression

string

Espressione del termine.
relationGuid

string

GUID della relazione.
status

AtlasTermRelationshipStatus

Stato della relazione di termine.
steward

string

Il responsabile del termine.
termGuid

string

GUID del termine.

AtlasStruct

Acquisisce i dettagli del contenuto dello struct. Non creata direttamente un'istanza, usata solo tramite AtlasEntity, AtlasClassification.

Nome Tipo Descrizione
attributes

Attributi dello struct.
lastModifiedTS

string

ETag per il controllo di concorrenza.
typeName

string

Nome del tipo.

AtlasTermCategorizationHeader

Informazioni di base per la categorizzazione del termine.

Nome Tipo Descrizione
categoryGuid

string

GUID della categoria.
description

string

Descrizione del record.
displayText

string

Testo visualizzato.
relationGuid

string

GUID della relazione.
status

AtlasTermRelationshipStatus

Stato della relazione di termine.

AtlasTermRelationshipStatus

Stato per la relazione del termine atlas

Nome Tipo Descrizione
ACTIVE

string

active
DEPRECATED

string

deprecated
DRAFT

string

Bozza
OBSOLETE

string

obsolete
OTHER

string

altro

EntityStatus

Stato : può essere attivo o eliminato

Nome Tipo Descrizione
ACTIVE

string

Lo stato è attivo.
DELETED

string

Lo stato viene eliminato.

PurviewObjectId

PurviewObjectId

Nome Tipo Descrizione
displayText

string

Testo visualizzato
guid

string

GUID dell'oggetto .
itemPath

string

Percorso elemento
name

string

Nome
properties

Dizionario di
resourceId

string

ID risorsa
typeName

string

Nome del tipo.
uniqueAttributes

Attributi univoci dell'oggetto.

ResourceLink

Nome Tipo Descrizione
displayName

string

Nome visualizzato per url.
url

string

URL Web. http o https

StatusAtlasRelationship

Stato per la relazione atlas

Nome Tipo Descrizione
ACTIVE

string

active
DELETED

string

deleted

TermStatus

Stato per il termine

Nome Tipo Descrizione
Alert

string

avviso
Approved

string

Approvato
Draft

string

Bozza
Expired

string

Scaduto

TimeBoundary

Acquisisce i dettagli del limite temporale

Nome Tipo Descrizione
endTime

string

Fine del limite di tempo.
startTime

string

Inizio del limite di tempo.
timeZone

string

Fuso orario del limite di tempo.