AuditSummary.Metas

Declaration

object AuditSummary.Metas

Discussion

Each entry in metas corresponds to one changed entity within the transaction and entity-type grouping that the parent AuditSummary row describes. An entry has the shape:

{
  "<EntityType>": "<entityId>",
  "detailId": "<EntityType.entityId.txnId>",
  "meta": { ...entity fields... }
}

• The array is empty by default.

• The request populates it only when you set options.metadata to latest or snapshot, with one entry per changed entity.

• latest fills meta with the entity’s current state from the live data store.

• snapshot fills meta with the entity’s state at the time of the event.

• You can use each entry’s detailId directly with GET /v1/change-history/{detailId} (Get Change History Detail) without constructing it manually.

Populating metas matters because an AuditSummary row doesn’t include entityId on its own, so you can’t construct a detailId from the row alone. Setting options.metadata (see AuditQuery.Options) to latest or snapshot gives you a ready-to-use detailId in each metas entry instead, so you don’t need a separate lookup.