Glossary - List Glossaries

Ottenere tutti i glossari registrati con Atlas.

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

Parametri dell'URI

Name In Required Type Description
Endpoint
path True
  • string

Endpoint del catalogo dell'account Purview. Esempio: https://{accountName}.purview.azure.com

ignoreTermsAndCategories
query
  • boolean

Indica se ignorare termini e categorie

limit
query
  • integer
int32

Dimensioni della pagina: per impostazione predefinita non è presente alcun paging.

offset
query
  • integer
int32

Offset per lo scopo della paginazione.

sort
query
  • string

Ordinamento, ASC (impostazione predefinita) o DESC.

Risposte

Name Type Description
200 OK

Matrice di glossari esistenti che soddisfano i criteri di ricerca o l'elenco vuoto se non viene trovata alcuna corrispondenza.

Other Status Codes

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

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 rappresentare l'account utente

Esempio

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"
      }
    ]
  }
]

Definizioni

AtlasClassification

AtlasClassification

AtlasGlossary

AtlasGlossary

AtlasRelatedCategoryHeader

AtlasRelatedCategoryHeader

AtlasRelatedTermHeader

AtlasRelatedTermHeader

AtlasTermRelationshipStatus

AtlasTermRelationshipStatus

Attributes

Attributi dello struct.

ErrorResponse

Risposta di errore dal servizio

SourceDetails

maggiori dettagli sulle informazioni sull'origine

Status

Stato

TimeBoundary

TimeBoundary

AtlasClassification

AtlasClassification

Name Type Description
attributes

Attributi dello struct.

entityGuid
  • string

GUID dell'entità.

entityStatus

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

lastModifiedTS
  • string

lastModifiedTS
ETag per il controllo della concorrenza.

removePropagationsOnEntityDelete
  • boolean

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

source
  • string

indicare l'origine che crea i dettagli di classificazione

sourceDetails

maggiori dettagli sulle informazioni sull'origine

typeName
  • string

Nome del tipo.

validityPeriods

Matrice di limiti di tempo che indica i periodi di validità.

AtlasGlossary

AtlasGlossary

Name Type Description
categories

Matrice di categorie.

classifications

Matrice di classificazioni.

guid
  • string

GUID dell'oggetto .

language
  • string

Lingua del glossario.

lastModifiedTS
  • string

lastModifiedTS
ETag per il controllo della concorrenza.

longDescription
  • string

Descrizione della versione lunga.

name
  • string

Nome dell'oggetto glossario.

qualifiedName
  • string

Nome completo dell'oggetto glossario.

shortDescription
  • string

Versione breve della descrizione.

terms

Matrice di intestazioni di termini correlate.

usage
  • string

Utilizzo del glossario.

AtlasRelatedCategoryHeader

AtlasRelatedCategoryHeader

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

AtlasRelatedTermHeader

Name Type Description
description
  • string

Descrizione del termine correlato.

displayText
  • string

Testo visualizzato.

expression
  • string

Espressione del termine .

relationGuid
  • string

GUID della relazione.

source
  • string

Origine del termine.

status

AtlasTermRelationshipStatus
Stato della relazione tra termini.

steward
  • string

Amministratore del termine.

termGuid
  • string

GUID del termine.

AtlasTermRelationshipStatus

AtlasTermRelationshipStatus

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

Attributes

Attributi dello struct.

Name Type Description

ErrorResponse

Risposta di errore dal servizio

Name Type Description
errorCode
  • string

Codice di errore.

errorMessage
  • string

Messaggio di errore.

requestId
  • string

ID richiesta.

SourceDetails

maggiori dettagli sulle informazioni sull'origine

Name Type Description

Status

Stato

Name Type Description
ACTIVE
  • string
DELETED
  • string

TimeBoundary

TimeBoundary

Name Type Description
endTime
  • string

Fine del limite di tempo.

startTime
  • string

Inizio del limite di tempo.

timeZone
  • string

Fuso orario del limite di tempo.