Skip to content
Settings

EntityUpdateCollectionRequest

Schema definition for EntityUpdateCollectionRequest

EntityUpdateCollectionRequest

dataFormatDataFormatrequired
transactionWindowinteger
The collection will be saved in a single transaction up to a maximum number of entities given by the transactionWindow. Collections exceeding the transactionWindow size will be saved in separate chunked transactions of the transactionWindow size.
transactionTimeoutMsinteger
Indicates the timeout of transaction for transactional save.
payloadsarrayrequired
Data payloads containing entities to update.

This schema defines the structure and validation rules for EntityUpdateCollectionRequest.

  • dataFormat (object, required):
  • transactionWindow (integer): The collection will be saved in a single transaction up to a maximum number of entities given by the transactionWindow. Collections exceeding the transactionWindow size will be saved in separate chunked transactions of the transactionWindow size.
  • transactionTimeoutMs (integer): Indicates the timeout of transaction for transactional save.
  • payloads (array, required): Data payloads containing entities to update.

See other schemas in the entity category.