Bulk Actions
Enables users to create actions that will perform asynchronously on a batch of entities on the environment level.
Entity types that are currently supported:
- Asset
- Entry
Currently supported actions:
Availability
Bulk actions are globally available for all customers.
Notifications
Since the execution of batch actions occur asynchronously, the status of the action can be checked by retrieving the batch action by the id in the response.
Limitations
Currently there are following limitations regarding bulk actions feature:
- Max active bulk actions per space is limited to 5.
- Max of 200 items per bulk action.
Bulk action schema
The bulk action has 4 top level properties as described below:
System property indicating the status of the bulk action is located inside the root sys property.
The status of the bulk action could be one of following:
- created: bulk action is created, but not acted on
- inProgress: the action has been started
- succeeded: the action has successfully completed
- failed: the action execution failed
Bulk action
Use this method to fetch the bulk action by id.
Permissions
Any user with read access to the supported entities can fetch a given Bulk Action.
Retention
Bulk action records are retained for 7 days.
Errors
- 404 Error is returned in case:
- The bulk action is not found
- The space is not found
- The current user is not allowed to see the bulk action
Publish bulk action
Use this method to publish the content linked in the payload.
Permissions
User can publish only existing content on which they have publish permissions.
Errors
- 400 Error is returned in case:
- One or more items do not exist or are inaccessible
- Provided version is incorrect
- 404 Error is returned in case:
- The space is not found
- 422 Error is returned in case:
- Validation failed
- Entity collection exceeds limit
- Duplicated items were found in the payload
- Version is not specified
- 429 Error is returned in case:
- The rate limit is exceeded due to number of active bulk actions
Unpublish bulk action
Use this method to unpublish the content linked in the payload.
Permissions
User can only unpublish existing content on which they have unpublish permissions.
Errors
- 400 Error is returned in case:
- Provided entity does not exists
- 404 Error is returned in case:
- The space is not found
- 422 Error is returned in case:
- Validation failed
- Entity collection exceeds limit
- Duplicate entities in the payload
- 429 Error is returned in case:
- The rate limit is exceeded due to the number of active bulk actions
Validate bulk action
Use this method to validate entities before publishing.
Permissions
User can only validate existing entities with publish permissions.
Errors
- 400 Error is returned in case:
- Provided entity does not exist
- 404 Error is returned in case:
- The space is not found
- 422 Error is returned in case:
- Validation failed
- Entity collection exeeds limit
- Duplicate entities in the payload
- 429 Error is returned in case:
- The rate limit is exceeded due to the number of active bulk actions
Locale-based bulk actions
Create a locale-based bulk action
This endpoint shows examples for publish, unpublish, and validate bulk actions.