Help getting started with BPM API

[BigBoss]

How can I start a BPM process via API? For example: /bpm/start/process/id. I want to initiate a BPM process via API and retrieve the results once it's completed, checking the status.

[lazovic]

Hi BigBoss,

You can start the BPM process via the API (provided that the start element is a Start Event) as follows:

POST http://ESPO_URL/api/v1/BpmnProcess

{
  "targetId": "66449ad6dd2ef4cd7",
  "targetName": "Test Account",
  "targetType": "Account",
  "flowchartId": "6655815376df5c698",
  "startElementId": "ft4z9k5s7a"
}

A target is a record for which the process will be run, and you can get the start element ID manually when you go to the record, which can be a target for the process, and select the desired BPM for processing. In the opened window you will see the start element ID: