Jump to

• Request
• Response

Find succession plans

post

/hcmRestApi/resources/11.13.18.05/talentEquivalentSuccessionPlans/action/findByAdvancedSearchQuery

Finds succession plans based on advanced query parameters.

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

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• autocompleteQuery: string
  Indicates whether the query is auto completed. Valid values are Y and N. The default value is Y.
• displayFields: array displayFields
  Fields returned by the find succession plans query. These fields can include succession plan's name, plan type, name of job or position associated with the plan, incumbent's display name, and the owner's name.
• filters: array filters
  Filters for the find succession plans query. The filter attributes can be the succession plan name, owner's name, plan type, status, job or position associated with the succession plan, and the incumbent's name.
• limit: number
  Restriction for the number of resources returned. If the limit exceeds the resource count, then the framework returns only the available resources.
• offset: number
  Starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• query: string
  Defines the where clause for the search. The resource collection is queried using the provided expressions. The value of this query parameter is one or more expressions.
• searchFields: array searchFields
  Search fields for the find succession plans query. The search fields can include the succession plan's name, plan type, name of job or position associated with the plan, incumbent's display name, and the owner's name.
• sort: array sort
  Sort criteria for the response returned by the find succession plans query.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Defines the where clause for the search. The resource collection is queried using the provided expressions. The value of this query parameter is one or more expressions.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Restriction for the number of resources returned. If the limit exceeds the resource count, then the framework returns only the available resources.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search fields for the find succession plans query. The search fields can include the succession plan's name, plan type, name of job or position associated with the plan, incumbent's display name, and the owner's name.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Filters for the find succession plans query. The filter attributes can be the succession plan name, owner's name, plan type, status, job or position associated with the succession plan, and the incumbent's name.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort criteria for the response returned by the find succession plans query.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Fields returned by the find succession plans query. These fields can include succession plan's name, plan type, name of job or position associated with the plan, incumbent's display name, and the owner's name.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Indicates whether the query is auto completed. Valid values are Y and N. The default value is Y.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Fields returned by the find succession plans query. These fields can include succession plan's name, plan type, name of job or position associated with the plan, incumbent's display name, and the owner's name.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Fields returned by the find succession plans query. These fields can include succession plan's name, plan type, name of job or position associated with the plan, incumbent's display name, and the owner's name.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Filters for the find succession plans query. The filter attributes can be the succession plan name, owner's name, plan type, status, job or position associated with the succession plan, and the incumbent's name.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Filters for the find succession plans query. The filter attributes can be the succession plan name, owner's name, plan type, status, job or position associated with the succession plan, and the incumbent's name.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

Search fields for the find succession plans query. The search fields can include the succession plan's name, plan type, name of job or position associated with the plan, incumbent's display name, and the owner's name.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Search fields for the find succession plans query. The search fields can include the succession plan's name, plan type, name of job or position associated with the plan, incumbent's display name, and the owner's name.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort criteria for the response returned by the find succession plans query.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sort criteria for the response returned by the find succession plans query.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "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"
    }
}

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Succession plans that match the find succession plans query.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Succession plans that match the find succession plans query."
        }
    },
    "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":"Succession plans that match the find succession plans query."
}

Succession plans that match the find succession plans query.

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"
    }
}

Back to Top