-
Notifications
You must be signed in to change notification settings - Fork 84
Protocol Batch
A batch action is a pseudo-action that groups several actions into a single request. A batch action may have additional properties such as to request actions to be performed as part of an atomic transaction.
Perform sub-actions specified in this action.
-
access_token
(string, optional)Access token to associate with each of the sub-actions. If any sub-action requires authentication, the batch action must be authenticated as well.
-
atomic
(boolean, optional,true
as default)Whether the sub-actions are part of an atomic transaction. If the transaction is an atomic one, sub-action to be performed after a failed operation will be canceled and sub-action performed before a failed operation will be rolled back.
-
actions
(array of objects, required)A list of sub-actions to be performed as part of a batch action. The sub-actions will be performed in the order they are specified in this array.
-
result
(array of objects)For each sub-action specified in the
actions
array, the returned result of each action will be included here in the order they are specified.