POST /atlas/v2/entity

Changed on

Create or update an entity. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of collections are not well supported. E.g., array<array<int>>, array<map<string, int>>. For each contact type, the maximum number of contacts is 20.

Request

  • Base URL
    {endpoint}/datamap/api
  • Auth
    OAuth 2
    Implicithttps://login.microsoftonline.com/common/oauth2/authorize
    Scopeshttps://purview.azure.net/.default

Query parameters

api-versionstring

The API version to use for this operation.

businessAttributeUpdateBehavior'ignore' | 'replace' | 'merge'

Used to define the update behavior for business attributes when updating entities.

collectionIdstring

The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection.

Request body

referredEntitiesobject

The referred entities.

Response

The request has succeeded.

guidAssignmentsobject

A map of GUID assignments with entities.

mutatedEntitiesobject

The entity headers of mutated entities.

Changes