Glossary - Partial Update

Referenz

Dienst:: Purview

API-Version:: 2023-09-01

Aktualisieren Sie das Glossar teilweise. Einige Eigenschaften wie qualifiedName dürfen nicht aktualisiert werden.

Bisher unterstützen wir nur teilweise Aktualisierungen von shortDescription, longDescription, Sprache und Verwendung für glossary.

Empfehlen Sie die Verwendung von "ignoreTermsAndCategories=true", um die Größe des Antworttexts zu reduzieren.

PUT {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/partial

Mit optionalen Parametern:

PUT {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/partial?api-version=2023-09-01&ignoreTermsAndCategories={ignoreTermsAndCategories}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string
glossaryId	path	True	string	Der global eindeutige Bezeichner für das Glossar.
api-version	query		string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
ignoreTermsAndCategories	query		boolean	Ob Begriffe und Kategorien ignoriert werden

Antworten

Name	Typ	Beschreibung
200 OK	AtlasGlossary	Die Anforderung war erfolgreich.
Other Status Codes	AtlasErrorResponse	Eine unerwartete Fehlerantwort.

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

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

Beispiele

Glossary_PartialUpdate

Beispielanforderung

HTTP

PUT {endpoint}/datamap/api/atlas/v2/glossary/c018ddaf-7c21-4b37-a838-dae5f110c3d8/partial?api-version=2023-09-01

{
  "longDescription": "Example Long Description"
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
  "qualifiedName": "Glossary",
  "name": "Glossary",
  "shortDescription": "Example Short Description",
  "longDescription": "Example Long Description",
  "lastModifiedTS": "3",
  "language": "en",
  "usage": "Example Glossary",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "createTime": 1672892675600,
  "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"
    }
  ]
}

Definitionen

Name	Beschreibung
AtlasClassification	Ein instance einer Klassifizierung. Es verfügt über keine Identität, dieses Objekt ist nur vorhanden, wenn es einer Entität zugeordnet ist.
AtlasErrorResponse	Eine Fehlerantwort des Diensts
AtlasGlossary	Das Glossarobjekt.
AtlasRelatedCategoryHeader	Die Kopfzeile der verknüpften Kategorie.
AtlasRelatedTermHeader	Die Kopfzeile des zugehörigen Begriffs.
AtlasTermRelationshipStatus	Status für Atlas-Ausdrucksbeziehung
EntityStatus	Status: kann aktiv sein oder gelöscht werden
TimeBoundary	Erfasst Details zur Zeitgrenze

AtlasClassification

Ein instance einer Klassifizierung. Es verfügt über keine Identität, dieses Objekt ist nur vorhanden, wenn es einer Entität zugeordnet ist.

Name	Typ	Beschreibung
attributes		Die Attribute der Struktur.
entityGuid	string	Die GUID der Entität.
entityStatus	EntityStatus	Status der Entität: Kann aktiv sein oder gelöscht werden. Gelöschte Entitäten werden nicht entfernt.
lastModifiedTS	string	ETag für die Parallelitätssteuerung.
removePropagationsOnEntityDelete	boolean	Bestimmt, ob Weitergaben beim Löschen von Entitäten entfernt werden.
typeName	string	Der Name des Typs.
validityPeriods	TimeBoundary[]	Ein Array von Zeitgrenzen, das Gültigkeitsdauern angibt.

AtlasErrorResponse

Eine Fehlerantwort des Diensts

Name	Typ	Beschreibung
errorCode	string	Der Fehlercode.
errorMessage	string	Die Fehlermeldung.
requestId	string	Die Anforderungs-ID.

AtlasGlossary

Das Glossarobjekt.

Name	Typ	Beschreibung
categories	AtlasRelatedCategoryHeader[]	Ein Array von Kategorien.
classifications	AtlasClassification[]	Ein Array von Klassifizierungen.
createTime	integer	Die Erstellungszeit des Datensatzes.
createdBy	string	Der Benutzer, der den Datensatz erstellt hat.
guid	string	Die GUID des -Objekts.
language	string	Die Sprache des Glossars.
lastModifiedTS	string	ETag für die Parallelitätssteuerung.
longDescription	string	Die Beschreibung der langen Version.
name	string	Der Name des Glossarobjekts.
qualifiedName	string	Der qualifizierte Name des Glossarobjekts.
shortDescription	string	Die Kurzversion der Beschreibung.
terms	AtlasRelatedTermHeader[]	Ein Array verwandter Begriffsheader.
updateTime	integer	Die Aktualisierungszeit des Datensatzes.
updatedBy	string	Der Benutzer, der den Datensatz aktualisiert hat.
usage	string	Die Verwendung des Glossars.

AtlasRelatedCategoryHeader

Die Kopfzeile der verknüpften Kategorie.

Name	Typ	Beschreibung
categoryGuid	string	Die GUID der Kategorie.
description	string	Die Beschreibung des Kategorieheaders.
displayText	string	Der Anzeigetext.
parentCategoryGuid	string	Die GUID der übergeordneten Kategorie.
relationGuid	string	Die GUID der Beziehung.

AtlasRelatedTermHeader

Die Kopfzeile des zugehörigen Begriffs.

Name	Typ	Beschreibung
description	string	Die Beschreibung des zugehörigen Begriffs.
displayText	string	Der Anzeigetext.
expression	string	Der Ausdruck des Begriffs.
relationGuid	string	Die GUID der Beziehung.
status	AtlasTermRelationshipStatus	Die status der Begriffsbeziehung.
steward	string	Der Steward des Begriffs.
termGuid	string	Die GUID des Begriffs.

AtlasTermRelationshipStatus

Status für Atlas-Ausdrucksbeziehung

Name	Typ	Beschreibung
ACTIVE	string	aktiv
DEPRECATED	string	deprecated
DRAFT	string	Entwurf
OBSOLETE	string	Veraltet
OTHER	string	Andere

EntityStatus

Status: kann aktiv sein oder gelöscht werden

Name	Typ	Beschreibung
ACTIVE	string	Die status ist aktiv.
DELETED	string	Die status wird gelöscht.

TimeBoundary

Erfasst Details zur Zeitgrenze

Name	Typ	Beschreibung
endTime	string	Das Ende der Zeitgrenze.
startTime	string	Der Anfang der Zeitgrenze.
timeZone	string	Die Zeitzone der Zeitgrenze.

Freigeben über