Entities

Merge entity ids

Idempotently tombstones source and unions projection sets into target.

post/v1/entities/merge

Request

Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
URL: /v1/entities/merge
Auth: HTTP bearer

Request body

expectedSourceVersioninteger required

expectedTargetVersioninteger required

sourceIdstring required

Tombstoned id.

targetIdstring required

Canonical id.

Example request

{
  "expectedSourceVersion": 1,
  "expectedTargetVersion": 1,
  "sourceId": "01J9Z8Q5K3R7V2C4M6N8P0T1S4",
  "targetId": "01J9Z8Q5K3R7V2C4M6N8P0T1S3"
}

Response

Merge result.

idempotentboolean required

True for a replay.

Example response

{
  "canonical": {
    "canonicalEntityId": "01J9Z8Q5K3R7V2C4M6N8P0T1S3",
    "displayName": "Acme",
    "id": "01J9Z8Q5K3R7V2C4M6N8P0T1S3",
    "kind": "company",
    "oneLineSummary": "Key supplier.",
    "resourceRefs": [
      "conduit:customer:cus_8fA2"
    ],
    "status": "active",
    "version": 1
  },
  "tombstone": {
    "canonicalEntityId": "01J9Z8Q5K3R7V2C4M6N8P0T1S3",
    "displayName": "Acme",
    "id": "01J9Z8Q5K3R7V2C4M6N8P0T1S3",
    "kind": "company",
    "oneLineSummary": "Key supplier.",
    "resourceRefs": [
      "conduit:customer:cus_8fA2"
    ],
    "status": "active",
    "version": 1
  }
}

Changes

No operation changes recorded.