Jump to

• Request
• Response

Find by advanced search query

post

/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/action/findByAdvancedSearchQuery

Creates a new message design for recruiting purposes, allowing users to define the structure and content of messages used in recruitment processes.

Request

Header Parameters

• Metadata-Context: string
  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: string
  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 for advanced search in recruiting message designs.
• displayFields: array displayFields
  Display fields to be shown in the search results for recruiting message designs.
• filters: array filters
  Filters used to narrow down the search results for recruiting message designs.
• limit: number
  Maximum number of records to return in the search results.
• offset: number
  Offset value for pagination in the search results.
• query: string
  Query string for advanced search in message designs.
• searchFields: array searchFields
  Search fields used to filter and retrieve specific message designs in the recruiting process.
• sort: array sort
  Sort criteria for the search results.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Offset value for pagination in the search results.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Query string for advanced search in message designs.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Maximum number of records to return in the search results.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search fields used to filter and retrieve specific message designs in the recruiting process.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Filters used to narrow down the search results for recruiting message designs.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "type":"array",
            "description":"Sort criteria for the search results.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Display fields to be shown in the search results for recruiting message designs.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Autocomplete query for advanced search in recruiting message designs.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Display fields to be shown in the search results for recruiting message designs.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Display fields to be shown in the search results for recruiting message designs.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: array

Filters used to narrow down the search results for recruiting message designs.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Filters used to narrow down the search results for recruiting message designs.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

Search fields used to filter and retrieve specific message designs in the recruiting process.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Search fields used to filter and retrieve specific message designs in the recruiting process.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : sort

Type: array

Sort criteria for the search results.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Sort criteria for the search results.",
    "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

  Return value for the advanced search query on message designs.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Return value for the advanced search query on message designs."
        }
    },
    "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":"Return value for the advanced search query on message designs."
}

Return value for the advanced search query on message designs.

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