This function takes a process definition (key or ID) and a list of users and returns those users in the list that are valid starters for the process.
It is used by the Start Workflow Action field type but may be useful in other contexts.
Parameters
| Name | Type | Description |
|---|---|---|
| processDefinition | String | Full process definition ID or process definition key of the process to check. If only a key is supplied the latest version will be used |
| userIds | Array | Array of site user names to test (lowercase) |
| All parameters are required | ||
Example Request
this.callWorkerMethod("workflow", "checkPotentialStarters",{
"processDefinition":"fileuplaod:2:509",
"userIds":["timg","tomc"]
});
Response
{
"jsonrpc": "2.0",
"id": 79,
"result": {
"id": "_20",
"result": {
"result": {
"userIds": ["timg"]
}
},
"jsonrpc": "2.0"
}
}
Last modified on August 03, 2023
Share this page
