Jump to

• Request
• Response
• Examples

Get an existing published candidate role by Id

get

/oiri/api/v1/published-candidate-role/{publishedCandidateRoleId}

Request

Path Parameters

• publishedCandidateRoleId: string

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : PublishedCandidateRoleDTO

Type: object

Show Source

• applicationCount(optional): string
• candidateRoleId(optional): string
• clusterId(optional): string
• description(optional): string
• entitlementCount(optional): string
• entitlementCoverage(optional): integer
• id(optional): string
• jobId(optional): string
• name(optional): string
• requestKey(optional): string
• status(optional): string
• userCount(optional): string
• userCoverage(optional): integer

{
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "jobId":{
            "type":"string"
        },
        "clusterId":{
            "type":"string"
        },
        "candidateRoleId":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "requestKey":{
            "type":"string"
        },
        "userCount":{
            "type":"string"
        },
        "entitlementCount":{
            "type":"string"
        },
        "applicationCount":{
            "type":"string"
        },
        "userCoverage":{
            "type":"integer"
        },
        "entitlementCoverage":{
            "type":"integer"
        }
    }
}

Back to Top

Examples

The following example shows how to retieve an existing candidate tole by ID.

curl -X GET\
-H "Accept: application/json"\
-H "Authorization: Bearer $token"\
"http://localhost:port/oiri/api/v1/published-candidate-role/32512c4890454e8b93075b246a5df5fd"

Example of the Response Body

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

{
"id": "32512c4890454e8b93075b246a5df5fd",
"name": "Sample Candidate Role",
"description": "Sample Candidate Role",
"jobId": "11cc57a41eaf48dfab2758f3bc2ad570",
"clusterId": 1,
"candidateRoleId": "2c1edfd520e44cce8fadf04c4c8da4b2",
"status": "PUBLISHED",
"requestKey": "-1",
"userCount": 1,
"entitlementCount": 9,
"applicationCount": 1,
"userCoverage": 50,
"entitlementCoverage": 50,
"createdDate": "2021-04-23T07:24:10.709+00:00",
"createdBy": "RFROST",
"lastModifiedDate": null
}

Back to Top