Create a schedule event
post
/hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}/child/scheduleEvents
Request
Path Parameters
-
schedRequestId(required): integer(int64)
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
-
Metadata-Context:
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:
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/json
Root Schema : schema
Type:
Show Source
object
-
allowEdits: string
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. -
importMode(required): string
Maximum Length:
20
Import modes for the schedule such as, FULL or UPDATE. Valid values are defined in the lookup HtsImportMode1. -
periodEndDate(required): string
(date)
Period end date of the imported schedule.
-
periodStartDate(required): string
(date)
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(required): string
Maximum Length:
1
Indicates whether to publish the imported schedules. Valid values are Y or N and defined in the HcmLookupYesNo lookup type. -
resourceReference: string
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. -
resourceReferenceType: string
Maximum Length:
30
Reference type of the resource, such as ASSIGNMENT_ID and ASSIGNMENT_NUMBER. Valid values are defined in the HtsResourceRefType1 lookup type. -
schedEventId: integer
(int64)
Surrogate ID for the schedule request event, available only to reference existing records.
-
schedRequestId: integer
(int64)
Surrogate ID for the schedule request for this schedule, available only to reference existing records.
-
scheduleShiftEvents: array
Schedule Shift Events
Title:
Schedule Shift Events
A list of imported values to create, update, or delete a shift. -
workerNotification(required): string
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-post-request
Type:
Show Source
object
-
allowEdits: string
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. -
referenceDay(required): string
(date)
Date used to group shifts that span multiple workdays into a single workday for processing. The import process checks that shifts marked with the DELETE action are on the reference day before deleting.
-
schedEventId: integer
(int64)
Unique identifier to reference the schedule event containing the shift.
-
schedShiftEventId: integer
(int64)
Surrogate ID for the schedule shift event, available only to reference existing records.
-
scheduleShiftAttributes: array
Schedule Shift Attributes
Title:
Schedule Shift Attributes
A list of imported values of time attributes associated with a shift. -
shiftAction(required): string
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. -
shiftCategory: string
Maximum Length:
30
Category of the shift, such as WORK. Valid values are defined in the LOV_shiftCategory lookup type. -
shiftCode: string
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. -
shiftDuration: integer
(int64)
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.
-
shiftEndTime: string
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. -
shiftNumber: string
Maximum Length:
120
Unique identifier of the shift in the source system. It's mandatory only when you update or delete shifts. -
shiftStartTime: string
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. -
shiftTimeNotWorked: integer
(int64)
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.
-
shiftType: string
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:
Show Source
object
-
attributeName: string
Maximum Length:
240
Name of the time attribute, such as Payroll Time Type or Absence Management Type. -
attributeValue: string
Maximum Length:
150
Value of the time attribute. For example, if the time attribute is Payroll Time Type, valid values might be Regular and Overtime. -
schedShiftAtrbId: integer
(int64)
Surrogate ID for the schedule shift time attribute, available only to reference existing records.
-
schedShiftEventId: integer
(int64)
Unique identifier to reference the shift event for the time attribute.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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:
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.
Root Schema : scheduleRequests-scheduleEvents-item-response
Type:
Show Source
object
-
allowEdits: string
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. -
importMode: string
Maximum Length:
20
Import modes for the schedule such as, FULL or UPDATE. Valid values are defined in the lookup HtsImportMode1. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
periodEndDate: string
(date)
Period end date of the imported schedule.
-
periodStartDate: string
(date)
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
Maximum Length:
1
Indicates whether to publish the imported schedules. Valid values are Y or N and defined in the HcmLookupYesNo lookup type. -
resourceReference: string
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. -
resourceReferenceType: string
Maximum Length:
30
Reference type of the resource, such as ASSIGNMENT_ID and ASSIGNMENT_NUMBER. Valid values are defined in the HtsResourceRefType1 lookup type. -
schedEventId: integer
(int64)
Surrogate ID for the schedule request event, available only to reference existing records.
-
schedRequestId: integer
(int64)
Surrogate ID for the schedule request for this schedule, available only to reference existing records.
-
scheduleShiftEvents: array
Schedule Shift Events
Title:
Schedule Shift Events
A list of imported values to create, update, or delete a shift. -
workerNotification: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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 : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : scheduleRequests-scheduleEvents-scheduleShiftEvents-item-response
Type:
Show Source
object
-
allowEdits: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
referenceDay: string
(date)
Date used to group shifts that span multiple workdays into a single workday for processing. The import process checks that shifts marked with the DELETE action are on the reference day before deleting.
-
schedEventId: integer
(int64)
Unique identifier to reference the schedule event containing the shift.
-
schedShiftEventId: integer
(int64)
Surrogate ID for the schedule shift event, available only to reference existing records.
-
scheduleShiftAttributes: array
Schedule Shift Attributes
Title:
Schedule Shift Attributes
A list of imported values of time attributes associated with a shift. -
shiftAction: string
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. -
shiftCategory: string
Maximum Length:
30
Category of the shift, such as WORK. Valid values are defined in the LOV_shiftCategory lookup type. -
shiftCode: string
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. -
shiftDuration: integer
(int64)
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.
-
shiftEndTime: string
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. -
shiftNumber: string
Maximum Length:
120
Unique identifier of the shift in the source system. It's mandatory only when you update or delete shifts. -
shiftStartTime: string
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. -
shiftTimeNotWorked: integer
(int64)
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.
-
shiftType: string
Maximum Length:
30
Types of shift, such as ELAPSED or TIME. Valid values are defined in the LOV_shiftType lookup type.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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:
Show Source
object
-
attributeName: string
Maximum Length:
240
Name of the time attribute, such as Payroll Time Type or Absence Management Type. -
attributeValue: string
Maximum Length:
150
Value of the time attribute. For example, if the time attribute is Payroll Time Type, valid values might be Regular and Overtime. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
schedShiftAtrbId: integer
(int64)
Surrogate ID for the schedule shift time attribute, available only to reference existing records.
-
schedShiftEventId: integer
(int64)
Unique identifier to reference the shift event for the time attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- scheduleShiftEvents
-
Parameters:
- schedEventId:
$request.path.schedEventId
- schedRequestId:
$request.path.schedRequestId
A list of imported values to create, update, or delete a shift. - schedEventId:
Examples
The following example shows how to create a schedule 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/300100106357759/child/scheduleEvents
Example of Payload
The following shows an example of the payload
{ "resourceReferenceType":"PERSON_NUMBER", "resourceReference":"100000017107211", "importMode":"FULL", "periodStartDate":"2017-01-16", "periodEndDate":"2017-01-16", "allowEdits":"Y", "publish":"Y", "workerNotification":"Y", "scheduleShiftEvents": [ { "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.
{ "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, "scheduleShiftEvents":[ {"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":300100106357783, "schedEventId":300100106357782, "allowEdits":"Y", "scheduleShiftAttributes":[ {"attributeName":"PayrollTimeType", "attributeValue":"Regular", "schedShiftAtrbId":300100106357784, "schedShiftEventId":300100106357783, "links":[...] }