BulkOperation

View as Markdown

BulkOperation

Use the BulkOperation class to perform actions—such as publishing, unpublishing, deleting, or updating workflows—on multiple entries and assets in a single API request.

create

The create method creates a new release in the stack.

NameTypeDescription
requestBody (required)JSONObject

The requestBody to create a release.

Example:

import contentstack;
Contentstack contentstack = new Contentstack.Builder().build();
Release release = contentstack.stack().releases();
Call<ResponseBody> response = release.create(requestBody).execute();
if (response.isSuccessful()) {
    System.out.println("Release created successfully.");
}

unpublish

The unpublish method removes multiple entries and assets from specific environments and locales.

NameTypeDescription
requestBody (required)JSONObject

Data to unpublish multiple items

Example:

import contentstack;

Contentstack contentstack = new Contentstack.Builder().build();

BulkOperation bulkOperation = contentstack.stack().bulkOperation();


Call<ResponseBody> response = bulkOperation.unpublish(requestBody).execute();

if (response.isSuccessful()) {

    System.out.println("Unpublished successfully");

}

delete

The delete method permanently deletes multiple entries or assets from your stack.

NameTypeDescription
requestBody (required)JSONObject

Data to delete multiple items from stack

Example:

import contentstack;

Contentstack contentstack = new Contentstack.Builder().build();

BulkOperation bulkOperation = contentstack.stack().bulkOperation();


Call<ResponseBody> response = bulkOperation.delete(requestBody).execute();

if (response.isSuccessful()) {

    System.out.println("Deleted successfully");

}

updateWorkflow

The updateWorkflow method updates the workflow stage for multiple entries in bulk.

NameTypeDescription
requestBody (required)JSONObject

The requestBody to update workflow

Example:

import contentstack;
Contentstack contentstack = new Contentstack.Builder().build();
BulkOperation bulkOperation = contentstack.stack().bulkOperation();

Call<ResponseBody> response = bulkOperation.updateWorkflow(requestBody).execute();
if (response.isSuccessful()) {
    System.out.println("Workflow updated");
}

addReleaseItems

The addReleaseItems method adds multiple entries or assets to a release in a single request.

NameTypeDescription
requestBody (required)JSONObject

Items to be added to the release

Example:

import contentstack;
Contentstack contentstack = new Contentstack.Builder().build();
BulkOperation bulkOperation = contentstack.stack().bulkOperation();

Call<ResponseBody> response = bulkOperation.addReleaseItems(requestBody).execute();
if (response.isSuccessful()) {
    System.out.println("Items added to release");
}

updateReleaseItems

The updateReleaseItems method updates all items in a release to their latest saved versions.

NameTypeDescription
requestBody (required)JSONObject

Configuration to update release items

Example:

import contentstack;
Contentstack contentstack = new Contentstack.Builder().build();
BulkOperation bulkOperation = contentstack.stack().bulkOperation();

Call<ResponseBody> response = bulkOperation.updateReleaseItems(requestBody).execute();
if (response.isSuccessful()) {
    System.out.println("Release items updated");
}

jobStatus

The jobStatus method allows you to check the status of a bulk job.

NameTypeDescription
params.job_id (required)string

UID of the bulk job

params.bulk_versionstring

The bulk operation version (2.0)

Example:

import contentstack;
Contentstack contentstack = new Contentstack.Builder().build();
BulkOperation bulkOperation = contentstack.stack().bulkOperation();

Call<ResponseBody> response = bulkOperation.jobStatus("jobId").execute();
if (response.isSuccessful()) {
    System.out.println("Job status retrieved");
}