Jump to

• Request
• Response

Find employee event questionnaires by advanced search query

post

/hcmRestApi/resources/11.13.18.05/communicateUIEmployeeEventQuestions/action/getEmployeeEventResponseForRegistrants

Retrieves all employee event questionnaires based on advanced search criteria using the provided query parameters.

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 for employee event questionnaires in the user interface.
• eventNumber: string
  Event number associated with the employee questionnaire.
• filters: object filters
  Additional Properties Allowed: additionalProperties

  Filters used to narrow down the search results for employee event questionnaires.
• limit: number
  Maximum number of records to return in the search results.
• offset: number
  Offset value for pagination in the search results.
• sort: object sort
  Additional Properties Allowed: additionalProperties

  Sort criteria for the employee event questionnaires search results.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Offset value for pagination in the search results.",
            "nullable":true
        },
        "eventNumber":{
            "type":"string",
            "description":"Event number associated with the employee questionnaire.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Maximum number of records to return in the search results.",
            "nullable":true
        },
        "filters":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "description":"Filters used to narrow down the search results for employee event questionnaires.",
            "nullable":true
        },
        "sort":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Sort criteria for the employee event questionnaires search results.",
            "nullable":true
        },
        "displayFields":{
            "type":"array",
            "description":"Display fields for employee event questionnaires in the user interface.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Display fields for employee event questionnaires in the user interface.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Display fields for employee event questionnaires in the user interface.",
    "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":"Filters used to narrow down the search results for employee event questionnaires.",
    "nullable":true
}

Filters used to narrow down the search results for employee event questionnaires.

Nested Schema : sort

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Sort criteria for the employee event questionnaires search results.",
    "nullable":true
}

Sort criteria for the employee event questionnaires search results.

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 for the advanced search query of employee event questionnaires.

{
    "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 of employee event questionnaires."
        }
    },
    "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 of employee event questionnaires."
}

Return value for the advanced search query of employee event questionnaires.

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