REST API for Oracle Fusion Cloud HCM

Get AI suggested candidates

post

/hcmRestApi/resources/11.13.18.05/talentEquivalentSuccessionPlans/action/aiCandidateRecommendations

Gets artificial intelligence based candidate suggestions for a succession plan.

Request

Header Parameters

Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

application/vnd.oracle.adf.action+json

Root Schema : schema

Type: object

Show Source

customFilters: object customFilters

Additional Properties Allowed: additionalProperties

Filters to filter the AI suggested candidates. The filter attributes can include the business unit, grade, and location of the suggested candidates.
displayFields: array displayFields

Information to display for the AI suggested candidates, which can include their Person ID, display name, department, job name, grade, location, manager, business unit, and assignment name.
planData: object planData

Additional Properties Allowed: additionalProperties

Information about the succession plan, which includes the succession plan ID, the plan type, and the job ID, position ID, or incumbent's Person ID based on the plan type.
sort: array sort

Attributes by which the AI suggested candidates can be sorted. The sort attributes include the suggestion strength, suggested candidate's name, job, and location.

{
    "type":"object",
    "properties":{
        "planData":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Information about the succession plan, which includes the succession plan ID, the plan type, and the job ID, position ID, or incumbent's Person ID based on the plan type.",
            "nullable":true
        },
        "sort":{
            "type":"array",
            "description":"Attributes by which the AI suggested candidates can be sorted. The sort attributes include the suggestion strength, suggested candidate's name, job, and location.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Information to display for the AI suggested candidates, which can include their Person ID, display name, department, job name, grade, location, manager, business unit, and assignment name.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "customFilters":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "description":"Filters to filter the AI suggested candidates. The filter attributes can include the business unit, grade, and location of the suggested candidates.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : customFilters

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    },
    "description":"Filters to filter the AI suggested candidates. The filter attributes can include the business unit, grade, and location of the suggested candidates.",
    "nullable":true
}

Filters to filter the AI suggested candidates. The filter attributes can include the business unit, grade, and location of the suggested candidates.

Nested Schema : displayFields

Type: array

Information to display for the AI suggested candidates, which can include their Person ID, display name, department, job name, grade, location, manager, business unit, and assignment name.

Show Source

Array of: string

{
    "type":"array",
    "description":"Information to display for the AI suggested candidates, which can include their Person ID, display name, department, job name, grade, location, manager, business unit, and assignment name.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : planData

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Information about the succession plan, which includes the succession plan ID, the plan type, and the job ID, position ID, or incumbent's Person ID based on the plan type.",
    "nullable":true
}

Information about the succession plan, which includes the succession plan ID, the plan type, and the job ID, position ID, or incumbent's Person ID based on the plan type.

Nested Schema : sort

Type: array

Attributes by which the AI suggested candidates can be sorted. The sort attributes include the suggestion strength, suggested candidate's name, job, and location.

Show Source

Array of: object items

Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Attributes by which the AI suggested candidates can be sorted. The sort attributes include the suggestion strength, suggested candidate's name, job, and location.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: string

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

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json
application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Root Schema : schema

Type: object

Show Source

result(required): object result

Additional Properties Allowed: additionalProperties

AI suggested candidates suitable for the succession plan's job role.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"AI suggested candidates suitable for the succession plan's job role."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "description":"AI suggested candidates suitable for the succession plan's job role."
}

AI suggested candidates suitable for the succession plan's job role.

Nested Schema : additionalProperties

Type: array

Show Source

Array of: object items

Additional Properties Allowed: additionalProperties

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

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}