Glossary - List Glossaries

Rufen Sie alle Glossare ab, die mit Atlas registriert sind.

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

URI-Parameter

Name In Required Type Description
Endpoint
path True
  • string

Der Katalogendpunkt Ihres Purview-Kontos. Beispiel: https://{accountName}.purview.azure.com

ignoreTermsAndCategories
query
  • boolean

Gibt an, ob Begriffe und Kategorien ignoriert werden

limit
query
  • integer
int32

Die Seitengröße – standardmäßig gibt es keine Paging.

offset
query
  • integer
int32

Der Offset für paginationszweck.

sort
query
  • string

Die Sortierreihenfolge, ASC (Standard) oder DESC.

Antworten

Name Type Description
200 OK

Ein Array vorhandener Glossare, die den Suchkriterien oder leeren Listen entsprechen, wenn nichts übereinstimmt.

Other Status Codes

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Scopes

Name Description
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

AtlasClassification

AtlasClassification

AtlasGlossary

AtlasGlossary

AtlasRelatedCategoryHeader

AtlasRelatedCategoryHeader

AtlasRelatedTermHeader

AtlasRelatedTermHeader

AtlasTermRelationshipStatus

AtlasTermRelationshipStatus

Attributes

Die Attribute der Struktur.

ErrorResponse

Eine Fehlerantwort vom Dienst

SourceDetails

Weitere Details zu Quellinformationen

Status

Status

TimeBoundary

TimeBoundary

AtlasClassification

AtlasClassification

Name Type Description
attributes

Die Attribute der Struktur.

entityGuid
  • string

Die GUID der Entität.

entityStatus

Status
Status der Entität – kann aktiv oder gelöscht werden. Gelöschte Entitäten werden nicht aus dem Atlas Store entfernt.

lastModifiedTS
  • string

lastModifiedTS
ETag für paralleles Steuerelement.

removePropagationsOnEntityDelete
  • boolean

Bestimmt, ob Verteilungen beim Löschen der Entität entfernt werden.

source
  • string

geben Sie die Quelle an, die das Klassifizierungsdetails erstellt

sourceDetails

Weitere Details zu Quellinformationen

typeName
  • string

Der Name des Typs.

validityPeriods

Ein Array von Zeitgrenzen, das gültigkeitsperioden angibt.

AtlasGlossary

AtlasGlossary

Name Type Description
categories

Ein Array von Kategorien.

classifications

Ein Array von Klassifizierungen.

guid
  • string

Die GUID des Objekts.

language
  • string

Die Sprache des Glossars.

lastModifiedTS
  • string

lastModifiedTS
ETag für paralleles Steuerelement.

longDescription
  • string

Die Beschreibung der langen Version.

name
  • string

Der Name des Glossarobjekts.

qualifiedName
  • string

Der qualifizierte Name des Glossarobjekts.

shortDescription
  • string

Die kurze Beschreibungsversion.

terms

Ein Array verwandter Ausdruckskopfzeilen.

usage
  • string

Die Verwendung des Glossars.

AtlasRelatedCategoryHeader

AtlasRelatedCategoryHeader

Name Type Description
categoryGuid
  • string

Die GUID der Kategorie.

description
  • string

Die Beschreibung der Rubrikenkopfzeile.

displayText
  • string

Der Anzeigetext.

parentCategoryGuid
  • string

Die GUID der übergeordneten Kategorie.

relationGuid
  • string

Die GUID der Beziehung.

AtlasRelatedTermHeader

AtlasRelatedTermHeader

Name Type Description
description
  • string

Die Beschreibung des zugehörigen Begriffs.

displayText
  • string

Der Anzeigetext.

expression
  • string

Der Ausdruck des Begriffs.

relationGuid
  • string

Die GUID der Beziehung.

source
  • string

Die Quelle des Begriffs.

status

AtlasTermRelationshipStatus
Der Status der Ausdrucksbeziehung.

steward
  • string

Der Steward des Begriffs.

termGuid
  • string

Die GUID des Begriffs.

AtlasTermRelationshipStatus

AtlasTermRelationshipStatus

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

Attributes

Die Attribute der Struktur.

Name Type Description

ErrorResponse

Eine Fehlerantwort vom Dienst

Name Type Description
errorCode
  • string

Der Fehlercode.

errorMessage
  • string

Die Fehlermeldung.

requestId
  • string

Die Anforderungs-ID.

SourceDetails

Weitere Details zu Quellinformationen

Name Type Description

Status

Status

Name Type Description
ACTIVE
  • string
DELETED
  • string

TimeBoundary

TimeBoundary

Name Type Description
endTime
  • string

Das Ende der Zeitgrenze.

startTime
  • string

Der Anfang der Zeitgrenze.

timeZone
  • string

Die Zeitzone der Zeitgrenze.