Jump to

• Request
• Response
• Examples

List similar roles with candidate roles coverage

get

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

Request

Path Parameters

• candidateRoleId: string
• taskId: string

Query Parameters

• entitlementThreshold: integer(float)
• topCount: integer(int32)
• userThreshold: integer(float)

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : SimilarRoleListResponse

Type: object

Show Source

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

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

Nested Schema : similarRoles

Type: array

Show Source

• Array of: object SimilarRoleDTO

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

Nested Schema : SimilarRoleDTO

Type: object

Show Source

• description(optional): string
• displayName(optional): string
• entitlementCount(optional): integer
• entitlementCoverage(optional): number
• id(optional): string
• name(optional): string
• userCount(optional): integer
• userCoverage(optional): number

{
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "entitlementCount":{
            "type":"integer"
        },
        "userCount":{
            "type":"integer"
        },
        "entitlementCoverage":{
            "type":"number"
        },
        "userCoverage":{
            "type":"number"
        }
    }
}

Back to Top

Examples

The following example shows how to list similar roles with candidate roles coverage.

curl -X GET\
-H "Accept: application/json"\
-H "Authorization: Bearer $token"\
"http://localhost:port/oiri/api/v1/tasks/70561adbfdd7474290b77d5903210c6b/candidate-roles/97d40d053dd74a45a6e944f45cbfae6a/similar-roles?topCount=5"

Example of the Response Body

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

{
"recordCount": 1,
"similarRoles": [
{
"id": "G265",
"name": "apr12role2",
"displayName": "apr12role2",
"description": "apr12role2",
"entitlementCount": 5,
"userCount": 3,
"entitlementCoverage": 100,
"userCoverage": 50
}
]
}

Back to Top