Jump to

• Request
• Response

Fetch upcoming events.

post

/hcmRestApi/resources/11.13.18.05/communicateUIEmployeeEvents/action/findUpcomingEventsForMyCommunications

Fetches upcoming events to present in the my communication dashboard.

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

• limit: number
  Limit input parameter to control number of records retrieved for findUpcomingEventsForMyCommunications.
• offset: number
  Offset input parameter to control pagination for findUpcomingEventsForMyCommunications.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"Offset input parameter to control pagination for findUpcomingEventsForMyCommunications.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Limit input parameter to control number of records retrieved for findUpcomingEventsForMyCommunications.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

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 using findUpcomingEventsForMyCommunications custom action.

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

Return value of the event search using findUpcomingEventsForMyCommunications custom action.

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