Jump to

• Request
• Response

List candidate rolewise entitlements user coverage for the given run

get

/oiri/api/v1/tasks/{taskId}/candidate-roles/entitlements-user-coverage

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 : EntitlementsUserCoverageListResponse

Type: object

Show Source

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

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

Nested Schema : entitlementsUserCoverageList

Type: array

Show Source

• Array of: object EntitlementsUserCoverageDTO

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

Nested Schema : EntitlementsUserCoverageDTO

Type: object

Show Source

• candidateRoleId(optional): string
• candidateRoleName(optional): string
• clusterId(optional): integer
• coveragePercentage(optional): number
• entitlementDisplayName(optional): string
• entitlementId(optional): string
• entitlementSerialNumber(optional): integer

{
    "properties":{
        "clusterId":{
            "type":"integer"
        },
        "candidateRoleId":{
            "type":"string"
        },
        "candidateRoleName":{
            "type":"string"
        },
        "entitlementSerialNumber":{
            "type":"integer"
        },
        "entitlementId":{
            "type":"string"
        },
        "entitlementDisplayName":{
            "type":"string"
        },
        "coveragePercentage":{
            "type":"number"
        }
    }
}

Back to Top