Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Page Properties
hiddentrue
idPROGRESS

Product Version
Report Note
Assignee

Resources & Remarks

Modification History

NameDateProduct VersionAction
Antje27JUL 20212021 Autumncreated
Agnieszka28 AUG 20212021 AutumnrLANG



As of Version

product version 2021 Autumn | component version 

Request MethodPOST
Response FormatJSON
Description


Excerpt

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 has been 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

Code Block
languageyml
titlerequest body
{
  "businessKey": "myBusinessKey",
  "name": "myProcessInstanceName",
  "processDefinitionKey": "oneTaskProcess",
  "variables": [
    {
      "name": "myVariable",
      "scope": "myScope",
      "type": "myType",
      "value": "test",
      "valueUrl": "http://...."
    }
  ]
}


Response Example


Code Block
languageyml
{
  "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://...."
        }
      ]
    }
  ]
}


...