1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Employee Event Details

Get all employee events

get

/hcmRestApi/resources/11.13.18.05/communicateUIEmployeeEventDetails

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds an event using event identifier.
      Finder Variables
      • EmployeeEventId; integer; Event identifier finder parameter to used fetch an event.
      • EmployeeEventLocationId; integer; Event location identifier finder parameter used to fetch an event using event location identifier.
    • findByNumber Finds an event by event number.
      Finder Variables
      • EventNumber; string; Event number finder parameter used to fetch an event.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CategoryCodes; string; Employee event category codes.
    • CategoryDescriptions; string; Employee event category descriptions.
    • City; string; City of an in-person event.
    • CityGeographyId; integer; City geography identifier of an in-person event.
    • Country; string; Country of an in-person event's location.
    • CountryCode; string; Country code for the location of an in-person event.
    • EmployeeEventId; integer; Unique identifier for the event.
    • EmployeeEventLocationId; integer; Location identifier for the event.
    • EndDate; string; End date of the event.
    • EventLastModifiedDate; string; Last modified date of the event.
    • EventNumber; string; Event number of the event.
    • EventStatus; string; Event status description.
    • EventStatusCode; string; Status code of the event.
    • Format; string; Format of the event.
    • FormatCode; string; Format code for the event.
    • LastRegisterDate; string; Last registration date for the event.
    • MaximumCapacity; integer; Maximum number of registrants allowed for the event.
    • MaximumCapacityInperson; integer; Maximum number of registrants allowed for an in-person event.
    • MaximumCapacityVirtual; integer; Maximum number of registrants allowed for a virtual event.
    • Name; string; Name of the event.
    • RegisteredCount; integer; Number of registrants in the event.
    • RegisteredCountInperson; integer; Number of registrants in the in-person event.
    • RegisteredCountVirtual; integer; Number of registrants in the virtual event.
    • StartDate; string; Start date of the event.
    • State; string; State in which the in-person event takes place.
    • StateGeographyId; integer; Geography identifier of the state in which the event takes place.
    • StatusUpdatedDate; string; Date the event's status was updated.
    • TimezoneCode; string; Time zone code for the event.
    • TimezoneDescription; string; Time zone description for the event.
    • WebConfLink; string; Web conference link for the virtual event.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : communicateUIEmployeeEventDetails
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : communicateUIEmployeeEventDetails-item-response
Type: object
Show Source
Nested Schema : Employee Event Metrics
Type: array
Title: Employee Event Metrics
The child resource for event metrics.
Show Source
Nested Schema : Employee Event Owners
Type: array
Title: Employee Event Owners
The child resource that provides details of the owners of the employee event.
Show Source
Nested Schema : communicateUIEmployeeEventDetails-eventMetrics-item-response
Type: object
Show Source
Nested Schema : communicateUIEmployeeEventDetails-owners-item-response
Type: object
Show Source
Links
updateStatusCode
Updates the status code of the employee event. This is used when the event transitions from one status to another.
Back to Top