POST /bpm-engine/api/processes

As of Version

product version 2021 Autumn | component version

Request Method POST

Response Format JSON

Description

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

The following query parameters can optionally be added to the request URL.

Meaning of HTTP status codes:

HTTP Status Code	Description
200, 201	Request was successful and the process instance was created.
400	Either the process definition was not found or an invalid variable has been passed. Status description contains additional information about the error.
401	The calling user is not authorized.

Request Header Content-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://...."
        }
      ]
    }
  ]
}