Glossary - List Glossaries

Pobierz wszystkie słowniki zarejestrowane w usłudze Atlas.

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

Parametry identyfikatora URI

Name In Required Type Description
Endpoint
path True
  • string

Punkt końcowy wykazu konta usługi Purview. Przykład: https://{accountName}.purview.azure.com

ignoreTermsAndCategories
query
  • boolean

Czy ignoruj terminy i kategorie

limit
query
  • integer
int32

Rozmiar strony — domyślnie nie ma stronicowania.

offset
query
  • integer
int32

Przesunięcie dla celu stronicowania.

sort
query
  • string

Kolejność sortowania, usługa ASC (domyślna) lub DESC.

Odpowiedzi

Name Type Description
200 OK

Tablica istniejących słowników pasujących do kryteriów wyszukiwania lub pustej listy, jeśli nic nie pasuje.

Other Status Codes

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

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 personifikacja konta użytkownika

Przykłady

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

Definicje

AtlasClassification

AtlasClassification

AtlasGlossary

AtlasGlossary

AtlasRelatedCategoryHeader

AtlasRelatedCategoryHeader

AtlasRelatedTermHeader

AtlasRelatedTermHeader

AtlasTermRelationshipStatus

AtlasTermRelationshipStatus

Attributes

Atrybuty struktury.

ErrorResponse

Odpowiedź o błędzie z usługi

SourceDetails

więcej szczegółów na temat informacji źródłowych

Status

Stan

TimeBoundary

TimeBoundary

AtlasClassification

AtlasClassification

Name Type Description
attributes

Atrybuty struktury.

entityGuid
  • string

Identyfikator GUID jednostki.

entityStatus

Stan
Stan jednostki — może być aktywny lub usunięty. Usunięte jednostki nie są usuwane z magazynu Atlas.

lastModifiedTS
  • string

lastModifiedTS
ETag dla kontrolki współbieżności.

removePropagationsOnEntityDelete
  • boolean

Określa, czy propagacje zostaną usunięte po usunięciu jednostki.

source
  • string

wskazuje źródło, które tworzy szczegóły klasyfikacji

sourceDetails

więcej szczegółów na temat informacji źródłowych

typeName
  • string

Nazwa typu.

validityPeriods

Tablica granic czasowych wskazująca okresy ważności.

AtlasGlossary

AtlasGlossary

Name Type Description
categories

Tablica kategorii.

classifications

Tablica klasyfikacji.

guid
  • string

Identyfikator GUID obiektu.

language
  • string

Język słownika.

lastModifiedTS
  • string

lastModifiedTS
ETag dla kontrolki współbieżności.

longDescription
  • string

Długi opis wersji.

name
  • string

Nazwa obiektu słownika.

qualifiedName
  • string

Kwalifikowana nazwa obiektu słownika.

shortDescription
  • string

Krótka wersja opisu.

terms

Tablica powiązanych nagłówków terminów.

usage
  • string

Użycie słownika.

AtlasRelatedCategoryHeader

AtlasRelatedCategoryHeader

Name Type Description
categoryGuid
  • string

Identyfikator GUID kategorii.

description
  • string

Opis nagłówka kategorii.

displayText
  • string

Tekst wyświetlany.

parentCategoryGuid
  • string

Identyfikator GUID kategorii nadrzędnej.

relationGuid
  • string

Identyfikator GUID relacji.

AtlasRelatedTermHeader

AtlasRelatedTermHeader

Name Type Description
description
  • string

Opis powiązanego terminu.

displayText
  • string

Tekst wyświetlany.

expression
  • string

Wyrażenie terminu.

relationGuid
  • string

Identyfikator GUID relacji.

source
  • string

Źródło terminu.

status

AtlasTermRelationshipStatus
Stan relacji terminów.

steward
  • string

Steward kadencji.

termGuid
  • string

Identyfikator GUID terminu.

AtlasTermRelationshipStatus

AtlasTermRelationshipStatus

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

Attributes

Atrybuty struktury.

Name Type Description

ErrorResponse

Odpowiedź o błędzie z usługi

Name Type Description
errorCode
  • string

Kod błędu.

errorMessage
  • string

Komunikat o błędzie.

requestId
  • string

Identyfikator żądania.

SourceDetails

więcej szczegółów na temat informacji źródłowych

Name Type Description

Status

Stan

Name Type Description
ACTIVE
  • string
DELETED
  • string

TimeBoundary

TimeBoundary

Name Type Description
endTime
  • string

Koniec granicy czasu.

startTime
  • string

Początek granicy czasu.

timeZone
  • string

Strefa czasowa granicy czasu.