Jump to

• Request
• Response

Get employee event response summary

post

/hcmRestApi/resources/11.13.18.05/communicateUIEmployeeEventQuestions/action/downloadResponseSummary

Retrieves a summary of employee event responses for the specified event questionnaire.

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

• eventNumber: string
  Event number associated with the employee event questionnaire.
• filters: object filters
  Additional Properties Allowed: additionalProperties

  Filters for retrieving employee event response summaries.
• sort: object sort
  Additional Properties Allowed: additionalProperties

  Sort order for the employee event response summary.

{
    "type":"object",
    "properties":{
        "eventNumber":{
            "type":"string",
            "description":"Event number associated with the employee event questionnaire.",
            "nullable":true
        },
        "filters":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "description":"Filters for retrieving employee event response summaries.",
            "nullable":true
        },
        "sort":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Sort order for the employee event response summary.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : filters

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    },
    "description":"Filters for retrieving employee event response summaries.",
    "nullable":true
}

Filters for retrieving employee event response summaries.

Nested Schema : sort

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Sort order for the employee event response summary.",
    "nullable":true
}

Sort order for the employee event response summary.

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): string
  Summary of the employee event response for the specified event.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Summary of the employee event response for the specified event."
        }
    },
    "additionalProperties":false
}

Back to Top