Jump to

• Request
• Response

Search for activities

post

/hcmRestApi/resources/11.13.18.05/recruitingRACItems/action/findByAdvancedSearchQuery

Searches for activities based on selected filters.

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 identifier.
• displayFields: array displayFields
  Display fields identifier that defines the fields to be shown in the user interface.
• filters: array filters
  Filter identifier that defines the filters that need to be applied to the activities list.
• limit: number
  Limit identifier that defines the number of activities to fetch at a time.
• offset: number
  Offset identifier.
• query: string
  Query used to search for activities.
• searchFields: array searchFields
  Search fields identifier that contains the keyword search fields.
• sort: array sort
  Sort identifier that defines the sort order to be applied to the activities list.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Offset identifier.",
            "nullable":true
        },
        "query":{
            "type":"string",
            "description":"Query used to search for activities.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Limit identifier that defines the number of activities to fetch at a time.",
            "nullable":true
        },
        "searchFields":{
            "type":"array",
            "description":"Search fields identifier that contains the keyword search fields.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "filters":{
            "type":"array",
            "description":"Filter identifier that defines the filters that need to be applied to the activities list.",
            "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 activities list.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "displayFields":{
            "type":"array",
            "description":"Display fields identifier that defines the fields to be shown in the user interface.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "autocompleteQuery":{
            "type":"string",
            "description":"Autocomplete query identifier.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

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

Show Source

• Array of: string

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

Nested Schema : filters

Type: array

Filter identifier that defines the filters that need to be applied to the activities list.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"Filter identifier that defines the filters that need to be applied to the activities list.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : searchFields

Type: array

Search fields identifier that contains the keyword search fields.

Show Source

• Array of: string

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

Nested Schema : sort

Type: array

Sort identifier that defines the sort order to be applied to the activities 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 activities 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 activities which satisfy 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 activities which satisfy 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 activities which satisfy the filters and queries applied."
}

Action that returns activities which satisfy 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