Jump to

• Request
• Response

Search for job applications using advanced search

post

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

Searches for job applications using advanced search.

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 in the advanced search.
• displayFields: array displayFields
  Display fields of the advanced search shown in the user interface.
• filters: array filters
  Filters used in the advanced search.
• gridViewCachedObjectIdList: array gridViewCachedObjectIdList
  Cached grid view object identifiers.
• gridViewCode: string
  Grid view code.
• gridViewConfigurationObject: string
  Grid view configuration.
• limit: number
  Limit that defines the number of job applications to fetch at a time in an advanced search.
• offset: number
  Offset used in the advanced search.
• query: string
  Query used in the advanced search.
• searchFields: array searchFields
  Search fields used in the advanced search.
• sort: array sort
  Sort identifier that defines the sort order to be applied to the job applications list.

{
    "type":"object",
    "properties":{
        "gridViewConfigurationObject":{
            "type":"string",
            "description":"Grid view configuration.",
            "nullable":true
        },
        "offset":{
            "type":"number",
            "description":"Offset used in the advanced search.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Query used in the advanced search.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Limit that defines the number of job applications to fetch at a time in an advanced search.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search fields used in the advanced search.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Filters used in the advanced search.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort identifier that defines the sort order to be applied to the job applications list.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Display fields of the advanced search shown in the user interface.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "gridViewCode":{
            "type":"string",
            "description":"Grid view code.",
            "nullable":true
        },
        "gridViewCachedObjectIdList":{
            "type":"array",
            "description":"Cached grid view object identifiers.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Autocomplete query in the advanced search.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Display fields of the advanced search shown in the user interface.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Display fields of the advanced search shown in the user interface.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Filters used in the advanced search.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Filters used in the advanced search.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : gridViewCachedObjectIdList

Type: array

Cached grid view object identifiers.

Show Source

• Array of: number

{
    "type":"array",
    "description":"Cached grid view object identifiers.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

Nested Schema : searchFields

Type: array

Search fields used in the advanced search.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Search fields used in the advanced search.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort identifier that defines the sort order to be applied to the job applications list.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sort identifier that defines the sort order to be applied to the job applications list.",
    "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

  Action that returns job applications according to the filters and queries applied.

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

Action that returns job applications according to 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