Glossary - Assign Term To Entities

Referenz

Dienst:: Purview

API-Version:: 2023-09-01

Weisen Sie den angegebenen Begriff der angegebenen Liste der verknüpften Objekte zu. Es wird empfohlen, kleine Batches mit mehreren API-Aufrufen zu verwenden.

Der Vorgang zum Erstellen oder Aktualisieren von Entitäten ist eine Alternative zum Zuweisen eines Begriffs zu mehreren Entitäten.

POST {endpoint}/datamap/api/atlas/v2/glossary/terms/{termId}/assignedEntities

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string
termId	path	True	string	Der global eindeutige Bezeichner für den Glossarbegriff.

Anforderungstext

Name	Typ	Beschreibung
body	AtlasRelatedObjectId[]	Ein Array verwandter Objekt-IDs, denen der Begriff zugeordnet werden muss.

Antworten

Name	Typ	Beschreibung
204 No Content		Es gibt keinen Inhalt, der für diese Anforderung gesendet werden kann, aber die Header können nützlich sein.
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_AssignTermToEntities

Beispielanforderung

HTTP

POST {endpoint}/datamap/api/atlas/v2/glossary/terms/8a7f65ec-6429-0b9b-3734-ec57bf1e34c2/assignedEntities

[
  {
    "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0",
    "relationshipAttributes": {
      "attributes": {
        "expression": "Example Expression",
        "confidence": 100,
        "description": "Example Description",
        "source": "ExampleSource"
      }
    }
  }
]

Beispiel für eine Antwort

Statuscode:: 204

Definitionen

Name	Beschreibung
AtlasErrorResponse	Eine Fehlerantwort des Diensts
AtlasRelatedObjectId	Verweis auf einen Objekt-instance des AtlasEntity-Typs, der in Beziehungsattributwerten verwendet wird
AtlasStruct	Erfasst Details des Strukturinhalts. Nicht direkt instanziiert, wird nur über AtlasEntity, AtlasClassification verwendet.
EntityStatus	Status: kann aktiv sein oder gelöscht werden
StatusAtlasRelationship	Status für atlas-Beziehung

AtlasErrorResponse

Eine Fehlerantwort des Diensts

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

AtlasRelatedObjectId

Verweis auf einen Objekt-instance des AtlasEntity-Typs, der in Beziehungsattributwerten verwendet wird

Name	Typ	Beschreibung
displayText	string	Der Anzeigetext.
entityStatus	EntityStatus	Status der Entität: Kann aktiv sein oder gelöscht werden. Gelöschte Entitäten werden nicht entfernt.
guid	string	Die GUID des -Objekts.
relationshipAttributes	AtlasStruct	Erfasst Details des Strukturinhalts. Nicht direkt instanziiert, wird nur über AtlasEntity, AtlasClassification verwendet.
relationshipGuid	string	Die GUID der Beziehung.
relationshipStatus	StatusAtlasRelationship	Die Enumeration der Beziehung status.
relationshipType	string	Beziehungstyp
typeName	string	Der Name des Typs.
uniqueAttributes		Die eindeutigen Attribute des Objekts.

AtlasStruct

Erfasst Details des Strukturinhalts. Nicht direkt instanziiert, wird nur über AtlasEntity, AtlasClassification verwendet.

Name	Typ	Beschreibung
attributes		Die Attribute der Struktur.
lastModifiedTS	string	ETag für die Parallelitätssteuerung.
typeName	string	Der Name des Typs.

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.

StatusAtlasRelationship

Status für atlas-Beziehung

Name	Typ	Beschreibung
ACTIVE	string	aktiv
DELETED	string	deleted

Freigeben über