Jump to

• Request
• Response

Search for job applications.

post

/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/action/findByAdvancedSearchQuery

Searches for job applications based on the selected filters.

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
  Autocomplete query identifier used to search for job applications.
• displayFields: array displayFields
  Display fields identifier contains the fields that need to be shown in the user interface.
• filters: array filters
  Filter identifier contains the filters that need to be applied against the list of job applications.
• gridViewCachedObjectIdList: array gridViewCachedObjectIdList
  Grid view cached object identifier list contains the cached grid view object identifiers.
• gridViewCode: string
  Grid view code identifier of the selected grid view.
• gridViewConfigurationObject: string
  Grid view configuration object contains the selected grid view configuration.
• limit: number
  Limit identifier to specify the number of job applications to fetch at a time.
• offset: number
  Offset identifier used to search for job applications.
• query: string
  Query identifier used to search for job applications.
• searchFields: array searchFields
  Search fields identifier contains the fields that the keyword search goes against.
• sort: array sort
  Sort identifier contains fields to sort the list of job applications.

{
    "type":"object",
    "properties":{
        "gridViewConfigurationObject":{
            "type":"string",
            "description":"Grid view configuration object contains the selected grid view configuration.",
            "nullable":true
        },
        "offset":{
            "type":"number",
            "description":"Offset identifier used to search for job applications.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Query identifier used to search for job applications.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Limit identifier to specify the number of job applications to fetch at a time.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search fields identifier contains the fields that the keyword search goes against.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Filter identifier contains the filters that need to be applied against the list of job applications.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort identifier contains fields to sort the list of job applications.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Display fields identifier contains the fields that need to be shown in the user interface.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "gridViewCode":{
            "type":"string",
            "description":"Grid view code identifier of the selected grid view.",
            "nullable":true
        },
        "gridViewCachedObjectIdList":{
            "type":"array",
            "description":"Grid view cached object identifier list contains the cached grid view object identifiers.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Autocomplete query identifier used to search for job applications.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Display fields identifier contains the fields that need to be shown in the user interface.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Display fields identifier contains the fields that need to be shown in the user interface.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Filter identifier contains the filters that need to be applied against the list of job applications.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Filter identifier contains the filters that need to be applied against the list of job applications.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : gridViewCachedObjectIdList

Type: array

Grid view cached object identifier list contains the cached grid view object identifiers.

Show Source

• Array of: number

{
    "type":"array",
    "description":"Grid view cached object identifier list contains the cached grid view object identifiers.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

Nested Schema : searchFields

Type: array

Search fields identifier contains the fields that the keyword search goes against.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Search fields identifier contains the fields that the keyword search goes against.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort identifier contains fields to sort the list of job applications.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sort identifier contains fields to sort the list of job applications.",
    "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

  Returns job applications based on the filters and queries applied.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Returns job applications based on the filters and queries applied."
        }
    },
    "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":"Returns job applications based on the filters and queries applied."
}

Returns job applications based on the filters and queries applied.

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