Jump to

• Request
• Response

Retrieve employee event registrants

post

/hcmRestApi/resources/11.13.18.05/communicateUIEmployeeEventRespondents/action/findByAdvancedSearchQuery

Retrieves employee event registrants meeting a filter criteria

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
  Fields to be fetched.
• eventNumber: string
  Event number for fetching registrants under it.
• filters: object filters
  Additional Properties Allowed: additionalProperties

  Filters to be applied in the registrants query.
• limit: number
  Number of records to be fetched in one invocation.
• offset: number
  Offset of records to be fetched in one invocation. This is used for pagination.
• sort: object sort
  Additional Properties Allowed: additionalProperties

  Sort to be applied on the result.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Offset of records to be fetched in one invocation. This is used for pagination.",
            "nullable":true
        },
        "eventNumber":{
            "type":"string",
            "description":"Event number for fetching registrants under it.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Number of records to be fetched in one invocation.",
            "nullable":true
        },
        "filters":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "description":"Filters to be applied in the registrants query.",
            "nullable":true
        },
        "sort":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Sort to be applied on the result.",
            "nullable":true
        },
        "displayFields":{
            "type":"array",
            "description":"Fields to be fetched.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : displayFields

Type: array

Fields to be fetched.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Fields to be fetched.",
    "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 to be applied in the registrants query.",
    "nullable":true
}

Filters to be applied in the registrants query.

Nested Schema : sort

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Sort to be applied on the result.",
    "nullable":true
}

Sort to be applied on the result.

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

  Output of the custom action findByAdvancedSearchQuery.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Output of the custom action 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":"Output of the custom action findByAdvancedSearchQuery."
}

Output of the custom action 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