Jump to

• Request
• Response
• Examples

List published candidate roles

post

/oiri/api/v1/published-candidate-role/.search

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• page(optional): object page
• recordCount(optional): integer
• searchFilters(optional): string
• sort(optional): object sort

{
    "properties":{
        "page":{
            "required":[
                "offset",
                "limit"
            ],
            "properties":{
                "offset":{
                    "type":"number"
                },
                "limit":{
                    "type":"number"
                }
            },
            "type":"object"
        },
        "sort":{
            "required":[
                "sortBy",
                "sortOrder"
            ],
            "properties":{
                "sortBy":{
                    "type":"string"
                },
                "sortOrder":{
                    "type":"string"
                }
            },
            "type":"object"
        },
        "searchFilters":{
            "type":"string"
        },
        "recordCount":{
            "type":"integer"
        }
    }
}

Nested Schema : page

Type: object

Show Source

• limit: number
• offset: number

{
    "required":[
        "offset",
        "limit"
    ],
    "properties":{
        "offset":{
            "type":"number"
        },
        "limit":{
            "type":"number"
        }
    },
    "type":"object"
}

Nested Schema : sort

Type: object

Show Source

• sortBy: string
• sortOrder: string

{
    "required":[
        "sortBy",
        "sortOrder"
    ],
    "properties":{
        "sortBy":{
            "type":"string"
        },
        "sortOrder":{
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : PublishedCandidateRoleListResponse

Type: object

Show Source

• count(optional): number
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): integer
• offset(optional): integer
• recordCount(optional): number

{
    "properties":{
        "limit":{
            "type":"integer"
        },
        "offset":{
            "type":"integer"
        },
        "recordCount":{
            "type":"number"
        },
        "count":{
            "type":"number"
        },
        "hasMore":{
            "type":"boolean"
        },
        "items":{
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

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

Nested Schema : items

Type: object

Back to Top

Examples

The following example shows how to list published candidate roles.

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
-H "Authorization: Bearer $token"\
"http://localhost:port/oiri/api/v1/published-candidate-role/.search" -d

Example of the Request Body

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

{"page":
{"offset":0,
"limit":10},
"sort":
{"sortBy":"name",
"sortOrder":"ASC"}
}

Example of the Response Body

The following is anexample of the response body in JSON format.

10,
"offset": 0,
"recordCount": 2,
"count": 2,
"hasMore": false,
"items": [
{
"id": "32512c4890454e8b93075b246a5df5fd",
"name": "Sample Candidate Role",
"description": "Sample Candidate Role",
"jobId": "11cc57a41eaf48dfab2758f3bc2ad570",
"clusterId": 1,
"candidateRoleId": "2c1edfd520e44cce8fadf04c4c8da4b2",
"status": "PUBLISHED",
"requestKey": "-1",
"userCount": 1,
"entitlementCount": 9,
"applicationCount": 1,
"userCoverage": 50,
"entitlementCoverage": 50,
"createdDate": "2021-04-23T07:24:10.709+00:00",
"createdBy": "RFROST",
"lastModifiedDate": null
},
{
"id": "5eb8bfd7fd1c4ba1b60c2ca178bff88d",
"name": "Sample Role 2",
"description": "Sample Role 2",
"jobId": "70561adbfdd7474290b77d5903210c6b",
"clusterId": 5,
"candidateRoleId": "023aa77378fa47b4b29fc73fcde5bd44",
"status": "PUBLISHED",
"requestKey": "-1",
"userCount": 1,
"entitlementCount": 14,
"applicationCount": 3,
"userCoverage": 50,
"entitlementCoverage": 50,
"createdDate": "2021-04-23T10:10:02.565+00:00",
"createdBy": "RFROST",
"lastModifiedDate": null
}
]
}

Back to Top