Skip to content

Identifying Entities

Depending on the operation you are performing, you may need to identify components and references in your batch request.

  • Ardoq OID — a unique identifier that is generated and assigned to every new entity created in Ardoq.
  • Alias — a user-defined identifier that can be used to reference existing components and references.
  • Batch ID — a temporary identifier assigned to entities created or upserted in the same batch request.
  • Match — a way to match multiple entities based on a set of criteria. Only applicable when deleting entities.

Components

Field Ardoq OID UniqueBy Alias Batch ID Match
parent ✅ - ✅ ✅ -

References

Field Ardoq OID UniqueBy Alias Batch ID Match
source ✅ - ✅ ✅ -
target ✅ - ✅ ✅ -