Glossary - List

Odwołanie

Service:: Purview

API Version:: 2023-09-01

Pobierz wszystkie słowniki. Zalecamy użycie limitu/przesunięcia, aby uzyskać wynik stronicowania. Zalecamy używanie polecenia "ignoreTermsAndCategories=true" i oddzielne pobieranie terminów/kategorii przy użyciu polecenia

"GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms" i

"GET '/datamap/api/atlas/v2/glossary/{glossaryId}/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}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string
api-version	query		string	Wersja interfejsu API do użycia dla tej operacji.
ignoreTermsAndCategories	query		boolean	Czy ignorować 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

Nazwa	Typ	Opis
200 OK	AtlasGlossary[]	Żądanie zakończyło się pomyślnie.
Other Status Codes	AtlasErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

OAuth2Auth

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

Scopes

Nazwa	Opis
https://purview.azure.net/.default

Przykłady

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

Definicje

Nazwa	Opis
AtlasClassification	Wystąpienie klasyfikacji; nie ma tożsamości, ten obiekt istnieje tylko wtedy, gdy jest skojarzony z jednostką.
AtlasErrorResponse	Odpowiedź o błędzie z usługi
AtlasGlossary	Obiekt słownika.
AtlasRelatedCategoryHeader	Nagłówek powiązanej kategorii.
AtlasRelatedTermHeader	Nagłówek powiązanego terminu.
AtlasTermRelationshipStatus	Stan relacji terminów atlasu
EntityStatus	Stan — może być aktywny lub usunięty
TimeBoundary	Przechwytuje szczegóły granicy czasu

AtlasClassification

Wystąpienie klasyfikacji; nie ma tożsamości, ten obiekt istnieje tylko wtedy, gdy jest skojarzony z jednostką.

Nazwa	Typ	Opis
attributes		Atrybuty struktury.
entityGuid	string	Identyfikator GUID jednostki.
entityStatus	EntityStatus	Stan jednostki — może być aktywny lub usunięty. Usunięte jednostki nie są usuwane.
lastModifiedTS	string	ETag dla kontrolki współbieżności.
removePropagationsOnEntityDelete	boolean	Określa, czy propagacje zostaną usunięte po usunięciu jednostki.
typeName	string	Nazwa typu.
validityPeriods	TimeBoundary[]	Tablica granic czasu wskazująca okresy ważności.

AtlasErrorResponse

Odpowiedź o błędzie z usługi

Nazwa	Typ	Opis
errorCode	string	Kod błędu.
errorMessage	string	Komunikat o błędzie.
requestId	string	Identyfikator żądania.

AtlasGlossary

Obiekt słownika.

Nazwa	Typ	Opis
categories	AtlasRelatedCategoryHeader[]	Tablica kategorii.
classifications	AtlasClassification[]	Tablica klasyfikacji.
createTime	integer	Godzina utworzenia rekordu.
createdBy	string	Użytkownik, który utworzył rekord.
guid	string	Identyfikator GUID obiektu.
language	string	Język słownika.
lastModifiedTS	string	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	AtlasRelatedTermHeader[]	Tablica powiązanych nagłówków terminów.
updateTime	integer	Czas aktualizacji rekordu.
updatedBy	string	Użytkownik, który zaktualizował rekord.
usage	string	Użycie słownika.

AtlasRelatedCategoryHeader

Nagłówek powiązanej kategorii.

Nazwa	Typ	Opis
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

Nagłówek powiązanego terminu.

Nazwa	Typ	Opis
description	string	Opis powiązanego terminu.
displayText	string	Tekst wyświetlany.
expression	string	Wyrażenie terminu.
relationGuid	string	Identyfikator GUID relacji.
status	AtlasTermRelationshipStatus	Stan relacji terminów.
steward	string	Steward kadencji.
termGuid	string	Identyfikator GUID terminu.

AtlasTermRelationshipStatus

Stan relacji terminów atlasu

Nazwa	Typ	Opis
ACTIVE	string	aktywne
DEPRECATED	string	deprecated
DRAFT	string	Projekt
OBSOLETE	string	Przestarzałe
OTHER	string	other

EntityStatus

Stan — może być aktywny lub usunięty

Nazwa	Typ	Opis
ACTIVE	string	Stan jest aktywny.
DELETED	string	Stan jest usuwany.

TimeBoundary

Przechwytuje szczegóły granicy czasu

Nazwa	Typ	Opis
endTime	string	Koniec granicy czasu.
startTime	string	Początek granicy czasowej.
timeZone	string	Strefa czasowa granicy czasu.