Jump to

• Request
• Response

List deleted entitlements of a candidate role

get

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

Request

Path Parameters

• candidateRoleId: string
• taskId: 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 : CandidateRoleEntitlementResponse

Type: object

Show Source

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

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

Nested Schema : data

Type: array

Show Source

• Array of: object EntitlementDTO

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

Nested Schema : EntitlementDTO

Type: object

Show Source

• applicationName(optional): string
• entitlementDisplayName(optional): string
• entitlementKey(optional): string
• misalignedCount(optional): integer
• usage(optional): number

{
    "properties":{
        "entitlementKey":{
            "type":"string"
        },
        "entitlementDisplayName":{
            "type":"string"
        },
        "applicationName":{
            "type":"string"
        },
        "usage":{
            "type":"number"
        },
        "misalignedCount":{
            "type":"integer"
        }
    }
}

Back to Top