Logo
OpenText Developer Cloud public resources API Documentation

Create a process instance

POST {{baseUrl}}/process-instances

Create a process instance using either processDefinitionKey, processDefinitionId or message name.processDefinitionKey, processDefinitionId are same as the key, id retrieved in the create a new executable process model response respectively.message is same as the message name configured in the process model.

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Content-Type
string




RESPONSES

status Created





Curl
curl -X POST 'baseUrl/process-instances' -H 'Content-Type: application/json' -d '{"businessKey":"SampleBusinessKey","comment":{"includeUserIds":false,"message":"do et dolore qui dolor","type":"te"},"includeUserIds":false,"message":"SampleMessage","name":"Sample Process","outcome":"SampleOutcome","processDefinitionId":"976626f9-3391-11ea-b509-eeee0affefe7","processDefinitionKey":"SampleKey","returnVariables":false,"startFormVariables":[{"encryption":false,"name":"SampleVariable","scope":"local","type":"string"},{"encryption":false,"name":"SampleVariable","scope":"local","type":"string"}],"transientVariables":[{"encryption":false,"name":"SampleVariable","scope":"local","type":"string"},{"encryption":false,"name":"SampleVariable","scope":"local","type":"string"}],"variables":[{"encryption":false,"name":"SampleVariable","scope":"local","type":"string"},{"encryption":false,"name":"SampleVariable","scope":"local","type":"string"}]}'

ENDPOINTS