POST /bpm-engine/api/processes

Owned by Technische Redaktion
Dec 01, 2022
2 min read
As of Version

product version 2021 Autumn | component version 

Request MethodPOST
Response FormatJSON
Description

Starts a process specified in a JSON structure in the request body.

Meaning of HTTP status codes:

HTTP Status CodeDescription
200, 201Request was successful and the process instance was created.
400Either the process definition was not found or an invalid variable was passed. Status description contains additional information about the error.
401The calling user is not authorized.
Request HeaderContent-Type: application/json
Request Example

https://<host>/bpm-engine/api/processes

request body
{
  "businessKey": "myBusinessKey",
  "name": "myProcessInstanceName",
  "processDefinitionKey": "oneTaskProcess",
  "variables": [
    {
      "name": "myVariable",
      "scope": "myScope",
      "type": "myType",
      "value": "test",
      "valueUrl": "http://...."
    }
  ]
}
Response Example
{
  "hasMoreItems": true,
  "numItems": 50,
  "objects": [
    {
      "businessKey": "myBusinessKey",
      "completed": true,
      "id": 187,
      "name": "myProcessInstanceName",
      "processDefinitionDescription": "A process definition description",
      "processDefinitionId": "oneTaskProcess:1:00000000-0000-0000-0000-000000000000",
      "processDefinitionName": "A process definition name",
      "startTime": "2018-04-17T10:17:43.902+0000",
      "startUserId": "user0001",
      "suspended": true,
      "variables": [
        {
          "name": "myVariable",
          "scope": "myScope",
          "type": "myType",
          "value": "test",
          "valueUrl": "http://...."
        }
      ]
    }
  ]
}