Jump to

• Request
• Response

List of users with entitlement assignment detail for a candidate role

get

/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/users-entitlement-assignment

Request

Path Parameters

• candidateRoleId: string
• taskId: string

Query Parameters

• maxEntitlementCount: integer(int32)
• maxUserCount: 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 : CandidateRoleUsersEntitlementAssignmentListResponse

Type: object

Show Source

• entitlementNames(optional): array entitlementNames
• maxEntitlementCount(optional): integer
• maxUserCount(optional): integer
• userDisplayNameWithFullCoverage(optional): array userDisplayNameWithFullCoverage
• usersPartialCoverageEntitlementAssignmentList(optional): array usersPartialCoverageEntitlementAssignmentList

{
    "properties":{
        "entitlementNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "userDisplayNameWithFullCoverage":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "usersPartialCoverageEntitlementAssignmentList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CandidateRoleUsersEntitlementAssignmentDTO"
            }
        },
        "maxUserCount":{
            "type":"integer"
        },
        "maxEntitlementCount":{
            "type":"integer"
        }
    }
}

Nested Schema : entitlementNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : userDisplayNameWithFullCoverage

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : usersPartialCoverageEntitlementAssignmentList

Type: array

Show Source

• Array of: object CandidateRoleUsersEntitlementAssignmentDTO

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

Nested Schema : CandidateRoleUsersEntitlementAssignmentDTO

Type: object

Show Source

• assignmentFlag(optional): array assignmentFlag
• userDisplayName(optional): string
• userId(optional): string

{
    "properties":{
        "userId":{
            "type":"string"
        },
        "userDisplayName":{
            "type":"string"
        },
        "assignmentFlag":{
            "type":"array",
            "items":{
                "type":"integer"
            }
        }
    }
}

Nested Schema : assignmentFlag

Type: array

Show Source

• Array of: integer

{
    "type":"array",
    "items":{
        "type":"integer"
    }
}

Back to Top