Skip to content

InitiateByProcess

Use this endpoint to start a new process instance directly from an external caller.

Initiates a new process instance using the specified parameters and returns the Id of the newly created work item.

Required Scope

process_initiate

Parameters

Parameter Name Description
apiKey A unique key used to authenticate and authorise the calling system.
logonId User’s logon Id.
logonProvider The authentication provider used for user login (e.g., 'Organization' for Emakin's default login system).
process The name or Id of the process to initiate.
task The name or Id of the task within the process.
version The version number or Id of the process. This can be null.
data XML data associated with the process. This can be null.
culture The culture preference. This can be null.

Example Call

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
POST https://mydomain.emakin.com/rest/v1/initiateByProcess

{
     "apiKey": "xxxx",
     "logonId": "[email protected]",
     "logonProvider": "Organization",
     "process": "e5134318-88bd-4a33-b561-4d78380734ce",
     "task": "c5350e5c-6e03-4b72-9522-49ab7f849b8a",
     "version": null,
     "data": "<pool><myField>ABC</myField></pool>",
     "culture": null
}

1
2
3
HTTP/1.1 200 OK

"716F8FCB-98C2-4591-8C43-043D54DEAADA"