Entity - Move Entities To Collection

Dienst:

Purview

API-Version:

2023-09-01

Verschieben vorhandener Entitäten in die Zielauflistung.

POST {endpoint}/datamap/api/entity/moveTo?api-version=2023-09-01&collectionId={collectionId}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
collectionId	query	True	string	Die Sammlung, in die Entitäten verschoben werden.

Anforderungstext

Name	Typ	Beschreibung
entityGuids	string[]	Ein Array von Entitäts-GUIDs, die in die Zielsammlung verschoben werden sollen.

Antworten

Name	Typ	Beschreibung
200 OK	EntityMutationResult	Die Anforderung ist erfolgreich.
Other Status Codes	AtlasErrorResponse	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

Entity_MoveEntitiesToCollection

Beispielanforderung

HTTP

POST {endpoint}/datamap/api/entity/moveTo?api-version=2023-09-01&collectionId=ExampleNewCollection

{
  "entityGuids": [
    "321493e3-3fb7-4b3e-9df7-3b69154174c2",
    "b2f9c306-cf65-4bb0-878e-cfaafde156b1"
  ]
}

Beispiel für eine Antwort

Statuscode:

200

{
  "mutatedEntities": {
    "UPDATE": [
      {
        "typeName": "azure_storage_account",
        "attributes": {
          "qualifiedName": "exampleaccount"
        },
        "lastModifiedTS": "3",
        "guid": "b2f9c306-cf65-4bb0-878e-cfaafde156b1",
        "status": "ACTIVE"
      },
      {
        "typeName": "azure_storage_account",
        "attributes": {
          "qualifiedName": "exampleaccount2"
        },
        "lastModifiedTS": "2",
        "guid": "321493e3-3fb7-4b3e-9df7-3b69154174c2",
        "status": "ACTIVE"
      }
    ]
  },
  "guidAssignments": {
    "-9514774903018192": "321493e3-3fb7-4b3e-9df7-3b69154174c2",
    "-9514774903018193": "b2f9c306-cf65-4bb0-878e-cfaafde156b1"
  }
}

Definitionen

Name	Beschreibung
AtlasClassification	Eine Instanz einer Klassifizierung; es hat keine Identität, dieses Objekt ist nur vorhanden, wenn es einer Entität zugeordnet ist.
AtlasEntityHeader	Eine Instanz einer Entität , z. B. hive_table, hive_database.
AtlasErrorResponse	Eine Fehlerantwort des Diensts
AtlasTermAssignmentHeader	Der Header für die Ausdruckszuweisung.
AtlasTermAssignmentStatus	Status für Die Begriffszuweisung
EntityMutationResult	Das Mutationsantwortergebnis der Entität.
EntityStatus	Status – kann aktiv oder gelöscht werden
MoveEntitiesOptions	MoveEntitiesOptions
TimeBoundary	Erfasst Zeitbegrenzungsdetails

AtlasClassification

Objekt

Eine Instanz einer Klassifizierung; es hat 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 oder gelöscht werden. Gelöschte Entitäten werden nicht entfernt.
lastModifiedTS	string	ETag für Parallelitätssteuerelement.
removePropagationsOnEntityDelete	boolean	Bestimmt, ob Verteilungen beim Löschen der Entität entfernt werden.
typeName	string	Der Name des Typs.
validityPeriods	TimeBoundary[]	Ein Array von Zeitgrenzen, das gültigkeitsperioden angibt.

AtlasEntityHeader

Objekt

Eine Instanz einer Entität , z. B. hive_table, hive_database.

Name	Typ	Beschreibung
attributes		Die Attribute der Struktur.
classificationNames	string[]	Ein Array von Klassifizierungsnamen.
classifications	AtlasClassification[]	Ein Array von Klassifizierungen.
displayText	string	Der Anzeigetext.
guid	string	Die GUID des Datensatzes.
isIncomplete	boolean	Gibt an, ob es sich um eine Shellentität handelt.
labels	string[]	etiketten
lastModifiedTS	string	ETag für Parallelitätssteuerelement.
meaningNames	string[]	Ein Array von Bedeutungen.
meanings	AtlasTermAssignmentHeader[]	Ein Array von Ausdruckszuweisungsheadern.
status	EntityStatus	Status der Entität – kann aktiv oder gelöscht werden. Gelöschte Entitäten werden nicht entfernt.
typeName	string	Der Name des Typs.

AtlasErrorResponse

Objekt

Eine Fehlerantwort des Diensts

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

AtlasTermAssignmentHeader

Objekt

Der Header für die Ausdruckszuweisung.

Name	Typ	Beschreibung
confidence	integer (int32)	Die Konfidenz der Begriffszuweisung.
createdBy	string	Der Benutzer, der den Datensatz erstellt hat.
description	string	Die Beschreibung der Begriffszuweisung.
displayText	string	Der Anzeigetext.
expression	string	Der Ausdruck der Ausdruckszuweisung.
relationGuid	string (uuid)	Die GUID der Beziehung.
status	AtlasTermAssignmentStatus	Der Status der Begriffszuweisung.
steward	string	Der Steward des Begriffs.
termGuid	string (uuid)	Die GUID des Ausdrucks.

AtlasTermAssignmentStatus

Enumeration

Status für Die Begriffszuweisung

Wert	Beschreibung
DEPRECATED	Der Status ist veraltet.
DISCOVERED	Der Status wird ermittelt.
IMPORTED	Der Status wird importiert.
OBSOLETE	Der Status ist veraltet.
OTHER	Anderer Status.
PROPOSED	Der Status wird vorgeschlagen.
VALIDATED	Der Status wird überprüft.

EntityMutationResult

Objekt

Das Mutationsantwortergebnis der Entität.

Name	Typ	Beschreibung
guidAssignments	object	Eine Zuordnung von GUID-Zuordnungen mit Entitäten.
mutatedEntities	object	Die Entitätsheader von mutierten Entitäten.
partialUpdatedEntities	AtlasEntityHeader[]	Ein Array von Entitätsheadern, die teilweise aktualisiert wurden.

EntityStatus

Enumeration

Status – kann aktiv oder gelöscht werden

Wert	Beschreibung
ACTIVE	Der Status ist aktiv.
DELETED	Der Status wird gelöscht.

MoveEntitiesOptions

Objekt

MoveEntitiesOptions

Name	Typ	Beschreibung
entityGuids	string[]	Ein Array von Entitäts-GUIDs, die in die Zielsammlung verschoben werden sollen.

TimeBoundary

Objekt

Erfasst Zeitbegrenzungsdetails

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