Jump to

• Request
• Response

Find upcoming events for the employee community

post

/hcmRestApi/resources/11.13.18.05/communicateUIEmployeeEvents/action/findUpcomingEventsForEmployeeCommunity

Retrieves upcoming events for an employee community based on specified 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

• employeeCommunityId: string
  Employee community identifier for filtering upcoming events.
• limit: number
  Maximum number of upcoming events to retrieve for the employee community.
• offset: number
  Offset value for pagination in retrieving upcoming events for the employee community.

{
    "type":"object",
    "properties":{
        "employeeCommunityId":{
            "type":"string",
            "description":"Employee community identifier for filtering upcoming events.",
            "nullable":true
        },
        "offset":{
            "type":"number",
            "description":"Offset value for pagination in retrieving upcoming events for the employee community.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Maximum number of upcoming events to retrieve for the employee community.",
            "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 for the upcoming events of an employee in the community.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"Return value for the upcoming events of an employee in the community."
        }
    },
    "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 upcoming events of an employee in the community."
}

Return value for the upcoming events of an employee in the community.

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