Jump to

• Request
• Response
• Examples

Search all candidate roles

post

/oiri/api/v1/candidate-roles/.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 : CandidateRoleListResponse

Type: object

Show Source

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

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

Nested Schema : candidateRoles

Type: array

Show Source

• Array of: object CandidateRoleDTO

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

Nested Schema : CandidateRoleDTO

Type: object

Show Source

• applicationCount(optional): integer
• clusterId(optional): integer
• confidence(optional): number
• createdBy(optional): string
• createdDate(optional): string
• description(optional): string
• entitlementCount(optional): integer
• entitlementCoverage(optional): integer
• id(optional): string
• jobId(optional): string
• lastModifiedDate(optional): string
• misAlignedEntitlementCount(optional): integer
• misAlignedUserCount(optional): integer
• name(optional): string
• status(optional): string
• totalEntitlementCount(optional): integer
• totalUserCount(optional): integer
• userCount(optional): integer
• userCoverage(optional): integer

{
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "jobId":{
            "type":"string"
        },
        "clusterId":{
            "type":"integer"
        },
        "status":{
            "type":"string"
        },
        "userCount":{
            "type":"integer"
        },
        "entitlementCount":{
            "type":"integer"
        },
        "applicationCount":{
            "type":"integer"
        },
        "totalUserCount":{
            "type":"integer"
        },
        "totalEntitlementCount":{
            "type":"integer"
        },
        "misAlignedUserCount":{
            "type":"integer"
        },
        "misAlignedEntitlementCount":{
            "type":"integer"
        },
        "userCoverage":{
            "type":"integer"
        },
        "entitlementCoverage":{
            "type":"integer"
        },
        "confidence":{
            "type":"number"
        },
        "createdDate":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "lastModifiedDate":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows how to search all candidate roles.

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
-H "Authorization: Bearer $token"\
"http://localhost:port/oiri/api/v1/candidate-roles/.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":"createdDate",
  "sortOrder":"DESC"},
"searchFilters":"status in (\"READY\")"}

Example of the Response Body

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

{
"id": "1",
"name": null,
"description": "cr_ Candidate Role for the Cluster : 1",
"jobId": "3292f90720af4ae3be8620bd9ca62c39",
"clusterId": 1,
"status": "READY",
"userCount": 11,
"entitlementCount": 9,
"applicationCount": 3,
"totalUserCount": 11,
"totalEntitlementCount": 9,
"misAlignedUserCount": 0,
"misAlignedEntitlementCount": 0,
"userCoverage": 50,
"entitlementCoverage": 50,
"confidence": 100,
"createdDate": "2021-04-21T11:11:21.544+00:00",
"createdBy": "RFROST",
"lastModifiedDate": "2021-04-21T11:11:21.544+00:00"
}
]
}

Back to Top