Jump to

• Request
• Response

List candidate rolewise entitlement frequency for the given run

get

/oiri/api/v1/tasks/{taskId}/candidate-roles/entitlement-frequency

Request

Path Parameters

• taskId: string

Query Parameters

• topCount: 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 : EntitlementFrequencyListResponse

Type: object

Show Source

• entitlementFrequencyList(optional): array entitlementFrequencyList
• topCount(optional): integer

{
    "properties":{
        "topCount":{
            "type":"integer"
        },
        "entitlementFrequencyList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EntitlementFrequencyDTO"
            }
        }
    }
}

Nested Schema : entitlementFrequencyList

Type: array

Show Source

• Array of: object EntitlementFrequencyDTO

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

Nested Schema : EntitlementFrequencyDTO

Type: object

Show Source

• candidateRoleId(optional): string
• candidateRoleName(optional): string
• clusterId(optional): integer
• entitlementDisplayName(optional): string
• entitlementId(optional): string
• entitlementSerialNumber(optional): integer
• frequency(optional): integer
• id(optional): integer

{
    "properties":{
        "id":{
            "type":"integer"
        },
        "clusterId":{
            "type":"integer"
        },
        "candidateRoleId":{
            "type":"string"
        },
        "candidateRoleName":{
            "type":"string"
        },
        "entitlementId":{
            "type":"string"
        },
        "entitlementDisplayName":{
            "type":"string"
        },
        "frequency":{
            "type":"integer"
        },
        "entitlementSerialNumber":{
            "type":"integer"
        }
    }
}

Back to Top