1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Schedule Requests
  4. Schedule Events

Get all schedule events

get

/hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}/child/scheduleEvents

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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 a schedule event using its identifier.
      Finder Variables
      • schedEventId; integer; Unique identifier for the schedule 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:
    • allowEdits; string; Indicates whether the scheduler can edit the imported schedule using the Planned Schedule task. Valid values are Y or N and defined in the HcmLookupYesNo lookup type. The default value is the attribute value in the worker time entry profile.
    • importMode; string; Import modes for the schedule such as, FULL or UPDATE. Valid values are defined in the lookup HtsImportMode1.
    • periodEndDate; string; Period end date of the imported schedule.
    • periodStartDate; string; Period start date of imported schedule. For schedule imports for a single day, enter this value: peridEndDate. You enter the actual date for the periodEndDate attribute.
    • publish; string; Indicates whether to publish the imported schedules. Valid values are Y or N and defined in the HcmLookupYesNo lookup type.
    • resourceReference; string; Resource reference that matches the specified resource reference type. For example, if the resource reference type is Person ID, then the resource reference is the unique identifier for the person.
    • resourceReferenceType; string; Reference type of the resource, such as ASSIGNMENT_ID and ASSIGNMENT_NUMBER. Valid values are defined in the HtsResourceRefType1 lookup type.
    • schedEventId; integer; Surrogate ID for the schedule request event, available only to reference existing records.
    • schedRequestId; integer; Surrogate ID for the schedule request for this schedule, available only to reference existing records.
    • workerNotification; string; Indicates whether to notify workers after publishing their schedules. Valid values are Y or N and defined in the HcmLookupYesNo lookup type.
  • 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 : scheduleRequests-scheduleEvents
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : scheduleRequests-scheduleEvents-item-response
Type: object
Show Source
  • Maximum Length: 1
    Indicates whether the scheduler can edit the imported schedule using the Planned Schedule task. Valid values are Y or N and defined in the HcmLookupYesNo lookup type. The default value is the attribute value in the worker time entry profile.
  • Maximum Length: 20
    Import modes for the schedule such as, FULL or UPDATE. Valid values are defined in the lookup HtsImportMode1.
  • Links
  • Period end date of the imported schedule.
  • Period start date of imported schedule. For schedule imports for a single day, enter this value: peridEndDate. You enter the actual date for the periodEndDate attribute.
  • Maximum Length: 1
    Indicates whether to publish the imported schedules. Valid values are Y or N and defined in the HcmLookupYesNo lookup type.
  • Maximum Length: 120
    Resource reference that matches the specified resource reference type. For example, if the resource reference type is Person ID, then the resource reference is the unique identifier for the person.
  • Maximum Length: 30
    Reference type of the resource, such as ASSIGNMENT_ID and ASSIGNMENT_NUMBER. Valid values are defined in the HtsResourceRefType1 lookup type.
  • Surrogate ID for the schedule request event, available only to reference existing records.
  • Surrogate ID for the schedule request for this schedule, available only to reference existing records.
  • Schedule Shift Events
    Title: Schedule Shift Events
    A list of imported values to create, update, or delete a shift.
  • Maximum Length: 1
    Indicates whether to notify workers after publishing their schedules. Valid values are Y or N and defined in the HcmLookupYesNo lookup type.
Nested Schema : Schedule Shift Events
Type: array
Title: Schedule Shift Events
A list of imported values to create, update, or delete a shift.
Show Source
Nested Schema : scheduleRequests-scheduleEvents-scheduleShiftEvents-item-response
Type: object
Show Source
  • Maximum Length: 1
    Indicates whether the scheduler can edit the imported shift using the Planned Schedule task. Valid values are Y or N and defined in the HcmLookupYesNo lookup type. If the value is Y or Null, shift editing is allowed when the value of the worker time entry profile Allow Edits option is Y and the schedule event isn't N.
  • Links
  • Date used to group shifts that span multiple work days into a single work day for processing. The import process checks that shifts marked with the DELETE action are on the reference day before deleting.
  • Unique identifier to reference the schedule event containing the shift.
  • Surrogate ID for the schedule shift event, available only to reference existing records.
  • Schedule Shift Attributes
    Title: Schedule Shift Attributes
    A list of imported values of time attributes associated with a shift.
  • Maximum Length: 30
    Actions to do on the shift, such as CREATE and DELETE. When the import mode is FULL, only the CREATE action is accepted. Valid values are defined in the LOV_shiftAction lookup type.
  • Maximum Length: 30
    Category of the shift, such as WORK. Valid values are defined in the LOV_shiftCategory lookup type.
  • Maximum Length: 120
    Unique identifier for a shift in the library. The shift code is language-independent and required only when you create or update shifts.
  • Duration of the shift in minutes. If the shift type is Elapsed, this attribute is mandatory. For other shift types, you need to provide the start and end times.
  • Maximum Length: 80
    End time of shifts of the type Time, entered with the time zone offset, for example, 2015-08-02T08:00:00+01:00.
  • Maximum Length: 120
    Unique identifier of the shift in the source system. It's mandatory only when you update or delete shifts.
  • Maximum Length: 80
    Start time of the Time-type shifts, entered with the time zone offset, for example, 2015-08-02T08:00:00+01:00.
  • Time not worked, and thus unpaid, during the shift in minutes. The shift value in the library provides the default value, which you can override.
  • Maximum Length: 30
    Types of shift, such as ELAPSED or TIME. Valid values are defined in the LOV_shiftType lookup type.
Nested Schema : Schedule Shift Attributes
Type: array
Title: Schedule Shift Attributes
A list of imported values of time attributes associated with a shift.
Show Source
Nested Schema : scheduleRequests-scheduleEvents-scheduleShiftEvents-scheduleShiftAttributes-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to retrieve all schedule events by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET -d <payload> http://host:port/hcmRestApi/resources//11.13.18.05/scheduleRequests/300100106357759/child/scheduleEvents

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200  OK 
Content-Type : application/json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
"items":[{
"resourceReferenceType":"PERSON_NUMBER",
"resourceReference":"100000017107211",
"importMode":"FULL",
"periodStartDate":"2017-01-16",
"periodEndDate":"2017-01-16",
"publish":"Y",
"workerNotification":"Y",
"allowEdits":"Y",
"schedEventId":300100106357770,
"schedRequestId":300100106357769,
"links":[...]
},
{
"resourceReferenceType":"PERSON_NUMBER",
"resourceReference":"100000017107211",
"importMode":"FULL",
"periodStartDate":"2017-01-16",
"periodEndDate":"2017-01-16",
"publish":"Y",
"workerNotification":"Y",
"allowEdits":"Y",
"schedEventId":300100106357782,
"schedRequestId":300100106357769,
"links":[...]
}
Back to Top