Jump to

• Request
• Response
• Examples

Get an existing candidate role by Id

get

/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}

Request

Path Parameters

• candidateRoleId: string
• taskId: string

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : CandidateRoleDTO

Type: object

Show Source

• 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

{
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "jobId":{
            "type":"string"
        },
        "clusterId":{
            "type":"integer"
        },
        "status":{
            "type":"string"
        },
        "userCount":{
            "type":"integer"
        },
        "entitlementCount":{
            "type":"integer"
        },
        "applicationCount":{
            "type":"integer"
        },
        "totalUserCount":{
            "type":"integer"
        },
        "totalEntitlementCount":{
            "type":"integer"
        },
        "misAlignedUserCount":{
            "type":"integer"
        },
        "misAlignedEntitlementCount":{
            "type":"integer"
        },
        "userCoverage":{
            "type":"integer"
        },
        "entitlementCoverage":{
            "type":"integer"
        },
        "confidence":{
            "type":"number"
        },
        "createdDate":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "lastModifiedDate":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows how to get an existing candidate role by ID.

curl -X GET\
-H "Accept: application/json"\
-H "Authorization: Bearer $token"\
"http://localhost:port/oiri/api/v1/tasks/11cc57a41eaf48dfab2758f3bc2ad570/candidate-roles/2c1edfd520e44cce8fadf04c4c8da4b2/"

Example of the Response Body

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

{
"id": "2c1edfd520e44cce8fadf04c4c8da4b2",
"name": "Sample Candidate Role",
"description": "Ab_ Candidate Role for the Cluster : 1",
"jobId": "11cc57a41eaf48dfab2758f3bc2ad570",
"clusterId": 1,
"status": "INPROGRESS",
"userCount": 1,
"entitlementCount": 9,
"applicationCount": 1,
"totalUserCount": 1,
"totalEntitlementCount": 9,
"misAlignedUserCount": 0,
"misAlignedEntitlementCount": 0,
"userCoverage": 50,
"entitlementCoverage": 50,
"confidence": 100,
"createdDate": "2021-04-22T12:43:06.721+00:00",
"createdBy": "RFROST",
"lastModifiedDate": "2021-04-22T12:51:48.485+00:00"
}

Back to Top