Skip to content
This repository has been archived by the owner on Dec 22, 2023. It is now read-only.

Protocol Batch

Rick Mak edited this page Apr 7, 2017 · 1 revision

Overview

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.

:batch

Perform sub-actions specified in this action.

Parameters

  • 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.

Returns

  • 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.

Clone this wiki locally