Jump to

• Request
• Response

For a given candidate role get similar Role Detail for entitlements with mode as common/candidate_role_only/role_only

get

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

Request

Path Parameters

• candidateRoleId: string
• roleId: string
• taskId: string

Query Parameters

• limit: integer(int32)
• mode: string
• offset: integer(int32)
• totalResults: integer(int32)

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : SimilarRoleEntitlementDetailResponse

Type: object

Show Source

• items(optional): array items
• totalResults(optional): integer

{
    "properties":{
        "totalResults":{
            "type":"integer"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SimilarRoleDetailEntitlementDTO"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object SimilarRoleDetailEntitlementDTO

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

Nested Schema : SimilarRoleDetailEntitlementDTO

Type: object

Show Source

• applicationDisplayName(optional): string
• applicationId(optional): string
• entitlementDisplayName(optional): string
• entitlementId(optional): string

{
    "properties":{
        "entitlementId":{
            "type":"string"
        },
        "entitlementDisplayName":{
            "type":"string"
        },
        "applicationId":{
            "type":"string"
        },
        "applicationDisplayName":{
            "type":"string"
        }
    }
}

Back to Top