Home > REST API > Endpoints > Management Endpoint > Bulk Endpoint
REST API

Bulk Endpoint

Updated: June 5, 2025

Get a Bulk Command Status

GET /management/bulk/COMMAND_ID

Path Parameters

Parameter Name Type Description
COMMAND_ID string The command id.

Response

If successful, returns a bulk status entity representing the bulk command status with the given COMMAND_ID path parameter.

Status Codes

  • 200 OK - Success.
  • 404 Not Found - Command with the given COMMAND_ID does not exist.

Sample

curl -u Administrator:Administrator \
http://localhost:8080/nuxeo/api/v1/management/bulk/0e1e6800-631a-4e04-a47c-241ea7b3596a

{
  "entity-type": "bulkStatus",
  "commandId": "0e1e6800-631a-4e04-a47c-241ea7b3596a",
  "state": "SCHEDULED",
  "processed": 0,
  "error": false,
  "errorCount": 0,
  "total": 0,
  "action": "recomputeThumbnails",
  "username": "system",
  "submitted": "2019-07-26T12:13:31.361Z",
  "scrollStart": null,
  "scrollEnd": null,
  "processingStart": null,
  "processingEnd": null,
  "completed": null,
  "processingMillis": 0
}

Abort a Bulk Command

DELETE /management/bulk/COMMAND_ID

Path Parameters

Parameter Name Type Description
COMMAND_ID string The command id.

Response

If successful, returns the updated bulk status entity.

Status Codes

  • 200 OK - Command is marked as cancelled.
  • 400 Bad request - Command is completed and cannot be cancelled.
  • 404 Not Found - Command with the given COMMAND_ID does not exist.

Sample

curl -u Administrator:Administrator -X DELETE \
http://localhost:8080/nuxeo/api/v1/management/bulk/0e1e6800-631a-4e04-a47c-241ea7b3596a

Learn More