/api/bpm/processes

Description

Within this endpoint a batch of processes can be suspended, activated, canceled, deleted or unlocked. In the request body, the following has to be sent: a list of processes together with the action (each process can have a different action) which should be performed. Possible actions are:

activate
suspend
cancel
delete
unlock

In the response, the status for each process sent is send back after applying the action:

Action	Return-Status
activate	active
suspend	suspended
cancel	cancelled
delete	deleted
unlock	unlocked

If the status of a process could not be changed, the return status is "error".
Only the following status changes are possible:

active → suspended, cancelled, deleted
suspended → active, cancelled, deleted
cancelled→ deleted
locked → unlocked

When deleting a non-existing process, the action is interpreted as successful.

When unlocking a non-existing process, the action is interpreted as successful.

Required Systemrole

R_WFADM_START (ID = 20)

Request
Method

PATCH

Optional Request Query Parameter

organizationId (String): The Id of the organization for deleting processes of an inactive organization.

Response
Format

JSON

Minimum Version

1.0.0

Request
Example

{
    "objects": [{
        "id": "2A42437656884AB6A90171C07D8C3870",
        "action": "activate"
    },{
        "id": "8A5C400C277B499CA26ED17E67F84841",
        "action": "activate"
    }]
}

Result
Example

{
    "objects": [{
        "id": "2A42437656884AB6A90171C07D8C3870",
        "state": "active"
    },{
        "id": "8A5C400C277B499CA26ED17E67F84841",
        "state": "active"
    }],
    "numItems": 2,
    "hasMoreItems": false,
    "totalNumItems": 2
}

Response Codes

200 - Success: When a batch of processes was sent, the body should be checked for details.

[PATCH] /processes

/api/bpm/processes