[GET] /candidates
/api/bpm/tasks/{id}/candidates
Description | To retrieve all users who can personalize and work on this task. In addition, all roles whose users are able to personalise and work on this task are returned. The result returns the id of the user or role, whether the user is absent or a substitute for another user, whether the user is a substitute for an absent user, whether the user has personalized the task (in which case the other candidates cannot see the task in their inbox at the moment) and the list of substitute users for an absent user or the list of users belonging to a role. The organization endpoint can be used or further information about users and roles, as this endpoint only returns the ID of both. |
|---|---|
Request | GET |
Response | JSON |
Minimum Version | 1.0.0 |
Request |
|
Result | {
"users": [{
"id": "274CB6C1780844BF987A121BC832AFA6",
"absent": false,
"substitute": true,
"personalized": false,
"directlyAssigned": false
}, {
"id": "774CB6C1780844BF987A121BC832AFBC",
"absent": true,
"substitute": false,
"personalized": false,
"directlyAssigned": true,
"substitutes": [{
"id": "374CB6C1780844BF987A121BC832AFFF"
}]
}],
"roles": [{
"id": "727A6EA824B543668A4CF56B3EDD98A9",
"absent": false,
"substitute": false
"personalized": false,
"directlyAssigned": true,
"children": [{
"id": "4D3AD9196CF8488FA4D881402A92AB9E"
},{
"id": "00F59593C9094EF9A9B515922C363051"
}]
}]
} |