Jump to

• Request
• Response

Download feedback response summary

post

/hcmRestApi/resources/11.13.18.05/communicateUIEmployeeEventQuestions/action/downloadFeedbackResponseSummary

Download feedback response summary

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

• confidential: boolean
  Confidential status of the feedback response summary.
• eventNumber: string
  Event number associated with the employee event questionnaire.
• filters: object filters
  Additional Properties Allowed: additionalProperties

  Filters the feedback response summary for downloading.
• sort: object sort
  Additional Properties Allowed: additionalProperties

  Sort order for the feedback response summary data.

{
    "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 the feedback response summary for downloading.",
            "nullable":true
        },
        "sort":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Sort order for the feedback response summary data.",
            "nullable":true
        },
        "confidential":{
            "type":"boolean",
            "description":"Confidential status of the feedback 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 the feedback response summary for downloading.",
    "nullable":true
}

Filters the feedback response summary for downloading.

Nested Schema : sort

Type: object

Additional Properties Allowed

Show Source

• string

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

Sort order for the feedback response summary data.

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 feedback responses downloaded for the employee event questionnaire.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Summary of feedback responses downloaded for the employee event questionnaire."
        }
    },
    "additionalProperties":false
}

Back to Top