---
title: "POST /atlas/v2/entity/bulk"
method: POST
path: "/atlas/v2/entity/bulk"
---

# POST /atlas/v2/entity/bulk

`POST /atlas/v2/entity/bulk`

Create or update entities in bulk.
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.

## Query parameters

- `api-version` string
- `collectionId` string
- `businessAttributeUpdateBehavior` 'ignore' | 'replace' | 'merge'

## Request body

- AtlasEntitiesWithExtInfo — An instance of an entity along with extended info - like hive_table, hive_database.
  - `referredEntities` object — The referred entities.
  - `entities` AtlasEntity[] — An array of entities.
    - `attributes` object — The attributes of the struct.
    - `typeName` string — The name of the type.
    - `lastModifiedTS` string — ETag for concurrency control.
    - `businessAttributes` object — Business attributes
    - `classifications` AtlasClassification[] — An array of classifications.
      - `attributes` object — The attributes of the struct.
      - `typeName` string — The name of the type.
      - `lastModifiedTS` string — ETag for concurrency control.
      - `entityGuid` string — The GUID of the entity.
      - `entityStatus` 'ACTIVE' | 'DELETED' — Status - can be active or deleted
      - `removePropagationsOnEntityDelete` boolean — Determines if propagations will be removed on entity deletion.
      - `validityPeriods` TimeBoundary[] — An array of time boundaries indicating validity periods.
        - `endTime` string — The end of the time boundary.
        - `startTime` string — The start of the time boundary.
        - `timeZone` string — The timezone of the time boundary.
    - `createTime` integer — The created time of the record.
    - `createdBy` string — The user who created the record.
    - `customAttributes` object — Custom Attribute
    - `guid` string — The GUID of the entity.
    - `homeId` string — The home ID of the entity.
    - `collectionId` string — The collection ID of the entity.
    - `isIncomplete` boolean — Whether it is a shell entity
    - `labels` string[] — labels
    - `meanings` AtlasTermAssignmentHeader[] — An array of term assignment headers indicating the meanings of the entity.
      - `confidence` integer — The confidence of the term assignment.
      - `createdBy` string — The user who created the record.
      - `description` string — The description of the term assignment.
      - `displayText` string — The display text.
      - `expression` string — The expression of the term assignment.
      - `relationGuid` string, uuid — Universally Unique Identifier
      - `status` 'DISCOVERED' | 'PROPOSED' | 'IMPORTED' | 'VALIDATED' | 'DEPRECATED' | 'OBSOLETE' | 'OTHER' — Status for term assignment
      - `steward` string — The steward of the term.
      - `termGuid` string, uuid — Universally Unique Identifier
    - `provenanceType` integer — Used to record the provenance of an instance of an entity or relationship.
    - `proxy` boolean — Determines if there's a proxy.
    - `relationshipAttributes` object — The attributes of relationship.
    - `status` 'ACTIVE' | 'DELETED' — Status - can be active or deleted
    - `updateTime` integer — The update time of the record.
    - `updatedBy` string — The user who updated the record.
    - `version` integer — The version of the entity.
    - `contacts` object — The dictionary of contacts for entities. Key could be Expert or Owner.

## Response `200`

The request has succeeded.

- EntityMutationResult — The mutation response result of entity.
  - `guidAssignments` object — A map of GUID assignments with entities.
  - `mutatedEntities` object — The entity headers of mutated entities.
  - `partialUpdatedEntities` AtlasEntityHeader[] — An array of entity headers that partially updated.
    - `attributes` object — The attributes of the struct.
    - `typeName` string — The name of the type.
    - `lastModifiedTS` string — ETag for concurrency control.
    - `classificationNames` string[] — An array of classification names.
    - `classifications` AtlasClassification[] — An array of classifications.
      - `attributes` object — The attributes of the struct.
      - `typeName` string — The name of the type.
      - `lastModifiedTS` string — ETag for concurrency control.
      - `entityGuid` string — The GUID of the entity.
      - `entityStatus` 'ACTIVE' | 'DELETED' — Status - can be active or deleted
      - `removePropagationsOnEntityDelete` boolean — Determines if propagations will be removed on entity deletion.
      - `validityPeriods` TimeBoundary[] — An array of time boundaries indicating validity periods.
        - `endTime` string — The end of the time boundary.
        - `startTime` string — The start of the time boundary.
        - `timeZone` string — The timezone of the time boundary.
    - `displayText` string — The display text.
    - `guid` string — The GUID of the record.
    - `isIncomplete` boolean — Whether it is a shell entity
    - `labels` string[] — labels
    - `meaningNames` string[] — An array of meanings.
    - `meanings` AtlasTermAssignmentHeader[] — An array of term assignment headers.
      - `confidence` integer — The confidence of the term assignment.
      - `createdBy` string — The user who created the record.
      - `description` string — The description of the term assignment.
      - `displayText` string — The display text.
      - `expression` string — The expression of the term assignment.
      - `relationGuid` string, uuid — Universally Unique Identifier
      - `status` 'DISCOVERED' | 'PROPOSED' | 'IMPORTED' | 'VALIDATED' | 'DEPRECATED' | 'OBSOLETE' | 'OTHER' — Status for term assignment
      - `steward` string — The steward of the term.
      - `termGuid` string, uuid — Universally Unique Identifier
    - `status` 'ACTIVE' | 'DELETED' — Status - can be active or deleted

## Other responses

- `default` — An unexpected error response.

---

[API](https://skmtc.net/azure/apis/purview-datamap.md) · [All operations](https://skmtc.net/azure/apis/purview-datamap/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/purview-datamap/versions/442226cb14a9/schema)