Jump to

• Request
• Response
• Examples

List candidate roles misaligned user entitlements

get

/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/misaligned-users/{userId}/entitlements

Request

Path Parameters

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

Examples

The following example shows how to list the misaligned user entitlements for candidate roles.

curl -X GET\
-H "Accept: application/json"\
-H "Authorization: Bearer $token"\
"http://localhost:port/oiri/api/v1/tasks/70561adbfdd7474290b77d5903210c6b/candidate-roles/97d40d053dd74a45a6e944f45cbfae6a/misaligned-users/G202/entitlements

Example of the Response Body

The following is an example of the response body in JSON format.

{
"recordCount": 2,
"data": [
{
"userKey": "G3006",
"userName": "KDADAY",
"employeeType": "Consultant",
"jobCode": "IC10003",
"managerName": "XELSYSADM",
"organizationName": "test1",
"usage": null,
"userDisplayName": "Karl Daday",
"managerDisplayName": "System Administrator",
"employeeNumber": "100039",
"departmentNumber": "Development",
"misalignedCount": null,
"extUserId": "3006",
"customAttributes": null
},
{
"userKey": "G3007",
"userName": "KBUIZON",
"employeeType": "Full-Time",
"jobCode": "IC10003",
"managerName": "XELSYSADM",
"organizationName": "Xellerate Users",
"usage": null,
"userDisplayName": "Kevin Buizon",
"managerDisplayName": "System Administrator",
"employeeNumber": "100038",
"departmentNumber": "Development",
"misalignedCount": null,
"extUserId": "3007",
"customAttributes": null
}
]
}

Back to Top