Jump to

• Request
• Response
• Examples

List applications for a published candidate role

get

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

Request

Path Parameters

• publishedCandidateRoleId: string

Query Parameters

• limit: integer(int32)
• offset: integer(int32)
• sortBy: string
• sortOrder: string

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : PublishedCandidateRoleApplicationResponse

Type: object

Show Source

• data(optional): array data
• recordCount(optional): integer

{
    "properties":{
        "recordCount":{
            "type":"integer"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ApplicationDTO"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object ApplicationDTO

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ApplicationDTO"
    }
}

Nested Schema : ApplicationDTO

Type: object

Show Source

• applicationDescription(optional): string
• applicationDisplayName(optional): string
• applicationId(optional): string
• applicationKey(optional): string
• applicationName(optional): string
• applicationType(optional): string

{
    "properties":{
        "applicationKey":{
            "type":"string"
        },
        "applicationId":{
            "type":"string"
        },
        "applicationName":{
            "type":"string"
        },
        "applicationDisplayName":{
            "type":"string"
        },
        "applicationDescription":{
            "type":"string"
        },
        "applicationType":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve an existing published candidate role 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