List users for a candidate role
post
/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/users/.search
Request
Path Parameters
Supported Media Types
- application/json
Response
Supported Media Types
- application/json
200 Response
OK
Nested Schema : CandidateRoleDTO
Type:
Show Source
object
-
applicationCount(optional):
integer
-
clusterId(optional):
integer
-
confidence(optional):
number
-
createdBy(optional):
string
-
createdDate(optional):
string
-
description(optional):
string
-
entitlementCount(optional):
integer
-
entitlementCoverage(optional):
integer
-
id(optional):
string
-
jobId(optional):
string
-
lastModifiedDate(optional):
string
-
misAlignedEntitlementCount(optional):
integer
-
misAlignedUserCount(optional):
integer
-
name(optional):
string
-
status(optional):
string
-
totalEntitlementCount(optional):
integer
-
totalUserCount(optional):
integer
-
userCount(optional):
integer
-
userCoverage(optional):
integer
Examples
The following example shows how to list users for a candidate role.
curl -X POST\ -H "Accept: application/json"\ -H "Content-Type: application/json"\ -H "Authorization: Bearer $token"\ "http://localhost:port/oiri/api/v1/tasks/70561adbfdd7474290b77d5903210c6b/candidate-roles/97d40d053dd74a45a6e944f45cbfae6a/users/.search"
Example of the Response Body
The following is an example of the response body in JSON format.
{ "limit": 10, "offset": 0, "recordCount": 6, "count": 6, "hasMore": false, "items": [ { "userKey": "G3004", "userName": "AMODI", "employeeType": "Consultant", "jobCode": "M10002", "managerName": "XELSYSADM", "organizationName": "Xellerate Users", "usage": 80, "userDisplayName": "Amit Modi", "managerDisplayName": "System Administrator", "employeeNumber": "100041", "departmentNumber": "Sales", "misalignedCount": null, "extUserId": "3004", "customAttributes": null }, { "userKey": "G3001", "userName": "KRUCKER", "employeeType": "Consultant", "jobCode": "M10004", "managerName": "XELSYSADM", "organizationName": "Xellerate Users", "usage": 60, "userDisplayName": "Kal Rucker", "managerDisplayName": "System Administrator", "employeeNumber": "100044", "departmentNumber": "PM", "misalignedCount": null, "extUserId": "3001", "customAttributes": null }, { "userKey": "G3006", "userName": "KDADAY", "employeeType": "Consultant", "jobCode": "IC10003", "managerName": "XELSYSADM", "organizationName": "test1", "usage": 80, "userDisplayName": "Karl Daday", "managerDisplayName": "System Administrator", "employeeNumber": "100039", "departmentNumber": "Development", "misalignedCount": null, "extUserId": "3006", "customAttributes": null }, { "userKey": "G3009", "userName": "KDIAS", "employeeType": "Full-Time", "jobCode": "IC10004", "managerName": "XELSYSADM", "organizationName": "Xellerate Users", "usage": 80, "userDisplayName": "Karl Dias", "managerDisplayName": "System Administrator", "employeeNumber": "100036", "departmentNumber": "Doc", "misalignedCount": null, "extUserId": "3009", "customAttributes": null }, { "userKey": "G3008", "userName": "KKUMAR", "employeeType": "Full-Time", "jobCode": "IC10003", "managerName": "XELSYSADM", "organizationName": "Xellerate Users", "usage": 100, "userDisplayName": "Keshav Kumar", "managerDisplayName": "System Administrator", "employeeNumber": "100037", "departmentNumber": "Development", "misalignedCount": null, "extUserId": "3008", "customAttributes": null }, { "userKey": "G3007", "userName": "KBUIZON", "employeeType": "Full-Time", "jobCode": "IC10003", "managerName": "XELSYSADM", "organizationName": "Xellerate Users", "usage": 80, "userDisplayName": "Kevin Buizon", "managerDisplayName": "System Administrator", "employeeNumber": "100038", "departmentNumber": "Development", "misalignedCount": null, "extUserId": "3007", "customAttributes": null } ] }