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

Create a schedule shift event

post

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

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=
  • 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=
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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
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.
  • 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-post-request
Type: object
Show Source
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-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
Links
scheduleShiftAttributes
Parameters:
  • schedEventId: $request.path.schedEventId
  • schedRequestId: $request.path.schedRequestId
  • schedShiftEventId: $request.path.schedShiftEventId
A list of imported values of time attributes associated with a shift.
Back to Top

Examples

The following example shows how to create a schedule shift event by submitting a POST request on the REST resource using cURL.

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

Example of Payload

The following shows an example of the payload

{
     "shiftNumber":"N552006",
     "shiftAction":"CREATE",
     "referenceDay":"2017-01-16",
     "shiftStartTime":"2017-01-16T15:00:00+01:00",
     "shiftEndTime":"2017-01-16T23:30:00+01:00",
     "shiftDuration":"",
     "shiftTimeNotWorked":"30",
     "shiftCode":"Swing",
     "shiftCategory":"WORK",
     "shiftType":"TIME",
     "allowEdits":"Y",
     "scheduleShiftAttributes":
      [
       {
        "attributeName":"PayrollTimeType",
        "attributeValue":"Regular"
       },
       {
        "attributeName":"Department",
        "attributeValue":"1000"
       }
      ]
}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 201  Created
Content-Type : application/json

Example of Response Body

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

{
"shiftDuration":null,
"shiftNumber":"N552006",
"shiftAction":"CREATE",
"referenceDay":"2017-01-16",
"shiftStartTime":"2017-01-16T15:00:00+01:00",
"shiftEndTime":"2017-01-16T23:30:00+01:00",
"shiftTimeNotWorked":30,
"shiftCategory":"WORK",
"shiftCode":"Swing",
"shiftType":"TIME",
"schedShiftEventId":300100106491733,
"schedEventId":300100106357770,
"allowEdits":"Y",
"scheduleShiftAttributes":[
	{
		"attributeName":"PayrollTimeType",
		"attributeValue":"Regular",
		"schedShiftAtrbId":300100106491734,
		"schedShiftEventId":300100106491733,
		"links":[...]
	},
	{
		"attributeName":"Department",
		"attributeValue":"1000",
		"schedShiftAtrbId":300100106491735,
		"schedShiftEventId":300100106491733,
		"links":[...]
	}
}
Back to Top