The following example shows how to list candidate roles for a job ID by status.

curl -X GET\
-H "Accept: application/json"\
-H "Authorization: Bearer $token"\
"http://localhost:port/oiri/api/v1/tasks/70561adbfdd7474290b77d5903210c6b/candidate-roles/list-by-status"

Example of the Response Body

The following is an example of the response body in JSON format.

{
"jobName": "SampleTask",
"totalEntitlementCount": 37,
"totalUserCount": 41,
"totalCandidateRoleCount": 18,
"candidateRoles": [
{
"id": "inprogress",
"label": "Review started",
"children": [
{
"id": 3,
"name": "Sample Role",
"description": "cr_ Candidate Role for the Cluster : 3",
"createdOn": "2021-04-22T12:50:51.828+00:00",
"modifiedOn": "2021-04-23T10:09:44.492+00:00",
"userCount": 1,
"applicationCount": 1,
"entitlementCount": 9,
"misAlignedUserCount": 0,
"misAlignedEntitlementCount": 0,
"status": "INPROGRESS",
"candidateRoleId": "7d35ef565462400e9ba965527527b048"
}
]
},
{
"id": "ready",
"label": "Review not started",
"children": [
{
"id": 8,
"name": null,
"description": "cr_ Candidate Role for the Cluster : 8",
"createdOn": "2021-04-22T12:50:51.835+00:00",
"modifiedOn": "2021-04-22T12:50:51.835+00:00",
"userCount": 6,
"applicationCount": 4,
"entitlementCount": 5,
"misAlignedUserCount": 5,
"misAlignedEntitlementCount": 5,
"status": "READY",
"candidateRoleId": "97d40d053dd74a45a6e944f45cbfae6a"
},
{
"id": 11,
"name": null,
"description": "cr_ Candidate Role for the Cluster : 11",
"createdOn": "2021-04-22T12:50:51.839+00:00",
"modifiedOn": "2021-04-22T12:50:51.839+00:00",
"userCount": 3,
"applicationCount": 3,
"entitlementCount": 3,
"misAlignedUserCount": 1,
"misAlignedEntitlementCount": 1,
"status": "READY",
"candidateRoleId": "b4c90f107ed54e589a673f6fd1dbe56b"
},
{
"id": 12,
"name": null,
"description": "cr_ Candidate Role for the Cluster : 12",
"createdOn": "2021-04-22T12:50:51.847+00:00",
"modifiedOn": "2021-04-22T12:50:51.847+00:00",
"userCount": 3,
"applicationCount": 2,
"entitlementCount": 2,
"misAlignedUserCount": 0,
"misAlignedEntitlementCount": 0,
"status": "READY",
"candidateRoleId": "a3f2e6f4329e430d88077fdf57c896d3"
},
{
"id": 15,
"name": null,
"description": "cr_ Candidate Role for the Cluster : 15",
"createdOn": "2021-04-22T12:50:51.849+00:00",
"modifiedOn": "2021-04-22T12:50:51.849+00:00",
"userCount": 1,
"applicationCount": 1,
"entitlementCount": 2,
"misAlignedUserCount": 0,
"misAlignedEntitlementCount": 0,
"status": "READY",
"candidateRoleId": "71c91e49ae4c4b69bb42f623480304ca"
},
{
"id": 17,
"name": null,
"description": "cr_ Candidate Role for the Cluster : 17",
"createdOn": "2021-04-22T12:50:51.855+00:00",
"modifiedOn": "2021-04-22T12:50:51.855+00:00",
"userCount": 1,
"applicationCount": 3,
"entitlementCount": 4,
"misAlignedUserCount": 0,
"misAlignedEntitlementCount": 0,
"status": "READY",
"candidateRoleId": "f73b85c5b8c0462bbb4cb3ea11352b8e"
},
{
"id": 20,
"name": null,
"description": "cr_ Candidate Role for the Cluster : 20",
"createdOn": "2021-04-22T12:50:51.861+00:00",
"modifiedOn": "2021-04-22T12:50:51.861+00:00",
"userCount": 5,
"applicationCount": 3,
"entitlementCount": 3,
"misAlignedUserCount": 2,
"misAlignedEntitlementCount": 1,
"status": "READY",
"candidateRoleId": "e2813b33c1a04996b4050c8f079aec68"
},
{
"id": 21,
"name": null,
"description": "cr_ Candidate Role for the Cluster : 21",
"createdOn": "2021-04-22T12:50:51.864+00:00",
"modifiedOn": "2021-04-22T12:50:51.864+00:00",
"userCount": 1,
"applicationCount": 4,
"entitlementCount": 4,
"misAlignedUserCount": 0,
"misAlignedEntitlementCount": 0,
"status": "READY",
"candidateRoleId": "885da4f502844ecb85fbb70deb282022"
},
{
"id": 23,
"name": null,
"description": "cr_ Candidate Role for the Cluster : 23",
"createdOn": "2021-04-22T12:50:51.867+00:00",
"modifiedOn": "2021-04-22T12:50:51.867+00:00",
"userCount": 4,
"applicationCount": 3,
"entitlementCount": 3,
"misAlignedUserCount": 3,
"misAlignedEntitlementCount": 2,
"status": "READY",
"candidateRoleId": "d984e5544277496bba8a09b2b2907c43"
},
{
"id": 26,
"name": null,
"description": "cr_ Candidate Role for the Cluster : 26",
"createdOn": "2021-04-22T12:50:51.870+00:00",
"modifiedOn": "2021-04-22T12:50:51.870+00:00",
"userCount": 3,
"applicationCount": 1,
"entitlementCount": 2,
"misAlignedUserCount": 0,
"misAlignedEntitlementCount": 0,
"status": "READY",
"candidateRoleId": "b410b414406a4e6f9bd4529aa26f5059"
},
{
"id": 27,
"name": null,
"description": "cr_ Candidate Role for the Cluster : 27",
"createdOn": "2021-04-22T12:50:51.872+00:00",
"modifiedOn": "2021-04-22T12:50:51.872+00:00",
"userCount": 1,
"applicationCount": 1,
"entitlementCount": 1,
"misAlignedUserCount": 0,
"misAlignedEntitlementCount": 0,
"status": "READY",
"candidateRoleId": "b2fe33d2cd1648649f566c1c30dd66db"
},
{
"id": 29,
"name": null,
"description": "cr_ Candidate Role for the Cluster : 29",
"createdOn": "2021-04-22T12:50:51.874+00:00",
"modifiedOn": "2021-04-22T12:50:51.874+00:00",
"userCount": 2,
"applicationCount": 4,
"entitlementCount": 6,
"misAlignedUserCount": 2,
"misAlignedEntitlementCount": 2,
"status": "READY",
"candidateRoleId": "88808142646a498287ab9d5b829c1e62"
},
{
"id": 31,
"name": null,
"description": "cr_ Candidate Role for the Cluster : 31",
"createdOn": "2021-04-22T12:50:51.876+00:00",
"modifiedOn": "2021-04-22T12:50:51.876+00:00",
"userCount": 1,
"applicationCount": 3,
"entitlementCount": 4,
"misAlignedUserCount": 0,
"misAlignedEntitlementCount": 0,
"status": "READY",
"candidateRoleId": "b4159783e0c44849a6585bd73c963f3f"
},
{
"id": 33,
"name": null,
"description": "cr_ Candidate Role for the Cluster : 33",
"createdOn": "2021-04-22T12:50:51.879+00:00",
"modifiedOn": "2021-04-22T12:50:51.879+00:00",
"userCount": 1,
"applicationCount": 1,
"entitlementCount": 3,
"misAlignedUserCount": 0,
"misAlignedEntitlementCount": 0,
"status": "READY",
"candidateRoleId": "130992a3cb0245b288ef67a65ca235e4"
},
{
"id": 34,
"name": null,
"description": "cr_ Candidate Role for the Cluster : 34",
"createdOn": "2021-04-22T12:50:51.882+00:00",
"modifiedOn": "2021-04-22T12:50:51.882+00:00",
"userCount": 1,
"applicationCount": 1,
"entitlementCount": 2,
"misAlignedUserCount": 0,
"misAlignedEntitlementCount": 0,
"status": "READY",
"candidateRoleId": "49902fef16de4affbc9fafa9db397ea4"
},
{
"id": 35,
"name": null,
"description": "cr_ Candidate Role for the Cluster : 35",
"createdOn": "2021-04-22T12:50:51.886+00:00",
"modifiedOn": "2021-04-22T12:50:51.886+00:00",
"userCount": 1,
"applicationCount": 1,
"entitlementCount": 1,
"misAlignedUserCount": 0,
"misAlignedEntitlementCount": 0,
"status": "READY",
"candidateRoleId": "a1ed1487015843518ea627697acb0b71"
}
]
},
{
"id": "published",
"label": "Published Roles",
"children": [
{
"id": 5,
"name": "Sample Role 2",
"description": "cr_ Candidate Role for the Cluster : 5",
"createdOn": "2021-04-22T12:50:51.831+00:00",
"modifiedOn": "2021-04-23T10:10:02.572+00:00",
"userCount": 1,
"applicationCount": 3,
"entitlementCount": 14,
"misAlignedUserCount": 0,
"misAlignedEntitlementCount": 0,
"status": "PUBLISHED",
"candidateRoleId": "023aa77378fa47b4b29fc73fcde5bd44"
}
]
},
{
"id": "discarded",
"label": "Discarded Roles",
"children": [
{
"id": 7,
"name": null,
"description": "cr_ Candidate Role for the Cluster : 7",
"createdOn": "2021-04-22T12:50:51.833+00:00",
"modifiedOn": "2021-04-23T10:13:10.868+00:00",
"userCount": 1,
"applicationCount": 3,
"entitlementCount": 4,
"misAlignedUserCount": 0,
"misAlignedEntitlementCount": 0,
"status": "READY_DISCARDED",
"candidateRoleId": "f80c8560a3b44fc196992de05f26950b"
}
]
}
]
}