Skip to content
Settings

EntityPatchPayload

Schema definition for EntityPatchPayload

EntityPatchPayload

entityIdstringrequired
ID of the entity to patch.
ifMatchstring
transactionId from the last read, or "*" for unconditional. Empty is rejected as precondition-required.
patchanyrequired
The patch document (RFC 7386 merge patch).
transitionstring
Transition to apply, or omit for loopback.

This schema defines the structure and validation rules for EntityPatchPayload.

  • entityId (string, required): ID of the entity to patch.
  • ifMatch (string): transactionId from the last read, or ”*” for unconditional. Empty is rejected as precondition-required.
  • patch (any, required): The patch document (RFC 7386 merge patch).
  • transition (string): Transition to apply, or omit for loopback.

See other schemas in the entity category.