Jump to

• Request
• Response

Search for event.

post

/hcmRestApi/resources/11.13.18.05/communicateUIEmployeeEvents/action/findByAdvancedSearchQuery

Searches for event using advanced query and 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

• displayFields: array displayFields
  Display fields input parameter to control attributes returned for findByAdvancedSearchQuery.
• filters: object filters
  Additional Properties Allowed: additionalProperties

  Input parameter to filter event search results for findByAdvancedSearchQuery.
• limit: number
  Limit input parameter to control number of records retrieved for findByAdvancedSearchQuery.
• offset: number
  Offset input parameter to control pagination for findByAdvancedSearchQuery.
• sort: object sort
  Additional Properties Allowed: additionalProperties

  Sort parameter to control the order of events search result for findByAdvancedSearchQuery.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Offset input parameter to control pagination for findByAdvancedSearchQuery.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Limit input parameter to control number of records retrieved for findByAdvancedSearchQuery.",
            "nullable":true
        },
        "filters":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "description":"Input parameter to filter event search results for findByAdvancedSearchQuery.",
            "nullable":true
        },
        "sort":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Sort parameter to control the order of events search result for findByAdvancedSearchQuery.",
            "nullable":true
        },
        "displayFields":{
            "type":"array",
            "description":"Display fields input parameter to control attributes returned for findByAdvancedSearchQuery.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Display fields input parameter to control attributes returned for findByAdvancedSearchQuery.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Display fields input parameter to control attributes returned for findByAdvancedSearchQuery.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : filters

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    },
    "description":"Input parameter to filter event search results for findByAdvancedSearchQuery.",
    "nullable":true
}

Input parameter to filter event search results for findByAdvancedSearchQuery.

Nested Schema : sort

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Sort parameter to control the order of events search result for findByAdvancedSearchQuery.",
    "nullable":true
}

Sort parameter to control the order of events search result for findByAdvancedSearchQuery.

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "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 of the event search sing findByAdvancedSearchQuery.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Return value of the event search sing findByAdvancedSearchQuery."
        }
    },
    "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 of the event search sing findByAdvancedSearchQuery."
}

Return value of the event search sing findByAdvancedSearchQuery.

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