REST API

Workflows Endpoint

Updated: October 14, 2024

Garbage Collect Workflows

DELETE /management/workflows/orphaned

Garbage collect all the orphaned workflows (for which all associated documents have been removed) as well as workflows in state 'done' or 'canceled'.

Response

If successful, returns a bulk status entity representing the bulk action status of the garbage collection bulk action.

The status can be monitored using the Bulk Endpoint.

Status Codes

  • 200 OK - Success.
  • 409 Conflict - A Garbage collect is already in progress.

Sample

curl -X DELETE -u Administrator:Administrator \
http://localhost:8080/nuxeo/api/v1/management/workflows/orphaned
{
  "entity-type": "bulkStatus",
  "commandId": "0e1e6800-631a-4e04-a47c-241ea7b3596a",
  "state": "SCHEDULED",
  "processed": 0,
  "error": false,
  "errorCount": 0,
  "total": 0,
  "action": "garbageCollectWokflows",
  "username": "system",
  "submitted": "2023-02-26T12:13:31.361Z",
  "scrollStart": null,
  "scrollEnd": null,
  "processingStart": null,
  "processingEnd": null,
  "completed": null,
  "processingMillis": 0
}