Glossary - List

Referencia

Szolgáltatás:: Purview

API-verzió:: 2023-09-01

Szerezze be az összes szószedetet. A lapszámozás eredményének lekéréséhez javasoljuk a korlát/eltolás használatát. A "ignoreTermsAndCategories=true" használatát javasoljuk, és a "GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms" és a "GET "/datamap/api/atlas/v2/glossary/{glossaryId}/categories" használatával külön-külön olvassa be a kifejezéseket/kategóriákat.

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

Opcionális paraméterekkel:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string (uri)
api-version	query		string minLength: 1	A művelethez használni kívánt API-verzió.
ignoreTermsAndCategories	query		boolean	Kifejezések és kategóriák figyelmen kívül hagyása
limit	query		integer (int32)	Az oldalméret – alapértelmezés szerint nincs lapozás.
offset	query		integer (int32)	A lapozási célú eltolás.
sort	query		string	A rendezési sorrend, az ASC (alapértelmezett) vagy a DESC.

Válaszok

Name	Típus	Description
200 OK	AtlasGlossary[]	A kérés sikeres volt.
Other Status Codes	AtlasErrorResponse	Váratlan hibaválasz.

Biztonság

OAuth2Auth

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
https://purview.azure.net/.default

Példák

Glossary_List

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 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"
      }
    ]
  }
]

Definíciók

Name	Description
AtlasClassification	Besorolás egy példánya; nem rendelkezik identitással, ez az objektum csak akkor létezik, ha egy entitáshoz van társítva.
AtlasErrorResponse	Hibaválasz a szolgáltatástól
AtlasGlossary	A szószedet objektum.
AtlasRelatedCategoryHeader	A kapcsolódó kategória fejléce.
AtlasRelatedTermHeader	A kapcsolódó kifejezés fejléce.
AtlasTermRelationshipStatus	Az Atlas kifejezéskapcsolat állapota
EntityStatus	Állapot – lehet aktív vagy törölve
TimeBoundary	Időhatár részleteinek rögzítése

AtlasClassification

Objektum

Besorolás egy példánya; nem rendelkezik identitással, ez az objektum csak akkor létezik, ha egy entitáshoz van társítva.

Name	Típus	Description
attributes		A szerkezet attribútumai.
entityGuid	string	Az entitás GUID azonosítója.
entityStatus	EntityStatus	Az entitás állapota – lehet aktív vagy törölhető. A törölt entitások nem törlődnek.
lastModifiedTS	string	ETag az egyidejűség-vezérléshez.
removePropagationsOnEntityDelete	boolean	Meghatározza, hogy a propagálások törlődnek-e az entitás törlésekor.
typeName	string	A típus neve.
validityPeriods	TimeBoundary[]	Az érvényességi időtartamokat jelző időhatárok tömbje.

AtlasErrorResponse

Objektum

Hibaválasz a szolgáltatástól

Name	Típus	Description
errorCode	string	A hibakód.
errorMessage	string	A hibaüzenet.
requestId	string (uuid)	A kérelem azonosítója.

AtlasGlossary

Objektum

A szószedet objektum.

Name	Típus	Description
categories	AtlasRelatedCategoryHeader[]	Kategóriák tömbje.
classifications	AtlasClassification[]	Besorolások tömbje.
createTime	integer (int64)	A rekord létrehozási ideje.
createdBy	string	A rekordot létrehozó felhasználó.
guid	string	Az objektum GUID azonosítója.
language	string	A szószedet nyelve.
lastModifiedTS	string	ETag az egyidejűség-vezérléshez.
longDescription	string	A hosszú verzió leírása.
name	string	A szószedetobjektum neve.
qualifiedName	string	A szószedetobjektum minősített neve.
shortDescription	string	A leírás rövid verziója.
terms	AtlasRelatedTermHeader[]	Kapcsolódó kifejezésfejlécek tömbje.
updateTime	integer (int64)	A rekord frissítési ideje.
updatedBy	string	A rekordot frissített felhasználó.
usage	string	A szószedet használata.

AtlasRelatedCategoryHeader

Objektum

A kapcsolódó kategória fejléce.

Name	Típus	Description
categoryGuid	string	A kategória GUID azonosítója.
description	string	A kategória fejlécének leírása.
displayText	string	A megjelenített szöveg.
parentCategoryGuid	string	A szülőkategória GUID azonosítója.
relationGuid	string	A kapcsolat GUID azonosítója.

AtlasRelatedTermHeader

Objektum

A kapcsolódó kifejezés fejléce.

Name	Típus	Description
description	string	A kapcsolódó kifejezés leírása.
displayText	string	A megjelenített szöveg.
expression	string	A kifejezés kifejezése.
relationGuid	string	A kapcsolat GUID azonosítója.
status	AtlasTermRelationshipStatus	A kifejezéskapcsolat állapota.
steward	string	A kifejezés intézője.
termGuid	string	A kifejezés GUID azonosítója.

AtlasTermRelationshipStatus

Enumerálás

Az Atlas kifejezéskapcsolat állapota

Érték	Description
ACTIVE	aktív
DEPRECATED	elavult
DRAFT	piszkozat
OBSOLETE	elavult
OTHER	más

EntityStatus

Enumerálás

Állapot – lehet aktív vagy törölve

Érték	Description
ACTIVE	Az állapot aktív.
DELETED	Az állapot törlődik.

TimeBoundary

Objektum

Időhatár részleteinek rögzítése

Name	Típus	Description
endTime	string	Az időhatár vége.
startTime	string	Az időhatár kezdete.
timeZone	string	Az időhatár időzónája.

Megosztás a következőn keresztül:

Glossary - List

URI-paraméterek

Válaszok

Biztonság

OAuth2Auth

Hatókörök

Példák

Glossary_List

Mintakérelem

Mintaválasz

Definíciók

AtlasClassification

AtlasErrorResponse

AtlasGlossary

AtlasRelatedCategoryHeader

AtlasRelatedTermHeader

AtlasTermRelationshipStatus

EntityStatus

TimeBoundary