Glossary - List

Riferimento

Service:: Purview

API Version:: 2023-09-01

Ottenere tutti i glossari. È consigliabile usare limite/offset per ottenere il risultato della paginazione. Consiglia di usare 'ignoreTermsAndCategories=true' e recuperare i termini/categorie separatamente usando

'GET /datamap/api/atlas/v2/glossariary/{glossariaryId}/terms' e

'GET '/datamap/api/atlas/v2/glossariary/{glossariaryId}/categories'.

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

With optional parameters:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string
api-version	query		string	Versione dell'API da usare per questa operazione.
ignoreTermsAndCategories	query		boolean	Indica se ignorare i termini e le categorie
limit	query		integer int32	Dimensioni della pagina: per impostazione predefinita non esiste alcun paging.
offset	query		integer int32	Offset per lo scopo della impaginazione.
sort	query		string	Ordinamento, ASC (impostazione predefinita) o DESC.

Risposte

Nome	Tipo	Descrizione
200 OK	AtlasGlossary[]	La richiesta ha avuto esito positivo.
Other Status Codes	AtlasErrorResponse	Risposta di errore imprevista.

Sicurezza

OAuth2Auth

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

Scopes

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

Esempio

Glossary_List

Sample Request

HTTP

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

Sample Response

Status code:: 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"
      }
    ]
  }
]

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
AtlasGlossary	Oggetto glossario.
AtlasRelatedCategoryHeader	Intestazione della categoria correlata.
AtlasRelatedTermHeader	Intestazione del termine correlato.
AtlasTermRelationshipStatus	Stato per la relazione del termine atlas
EntityStatus	Stato : può essere attivo o eliminato
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.

AtlasGlossary

Oggetto glossario.

Nome	Tipo	Descrizione
categories	AtlasRelatedCategoryHeader[]	Matrice di categorie.
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.
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.

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.

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.

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.

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.