Create all the workforce schedule shifts for the specified unit and period
post
/hcmRestApi/resources/11.13.18.05/workforceSchedules/{ScheduleId}/child/workerShifts
Request
Path Parameters
-
ScheduleId(required): integer
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AssignedBy: integer
(int64)
Person who assigned the open shift.
-
AssignmentDate: string
(date-time)
Date when the open shift was assigned.
-
AssignmentId: integer
(int64)
Default Value:
-1
Assignment identifier for the worker scheduled for the shift. -
AssignmentMode: string
Title:
Assignment Source
Maximum Length:30
Method used to assign the shift to the worker. -
BreakDuration: integer
(int32)
Title:
Break Duration
Break duration in minutes. -
Comments: string
Title:
What else do people need to know about this shift?
Maximum Length:4000
Shift notes. -
CompetencyId: integer
Unique identifier for the competency.
-
DeleteFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the workforce schedule shift needs to be deleted. -
EndDateTime: string
(date-time)
Shift end date and time.
-
EndTimeTZOffset: integer
(int32)
End time for the workforce schedule shift with time zone offset, for example, -360.
-
JobProfileCode: string
Maximum Length:
30
Unique identifier for the job profile code. -
JobProfileId: integer
Unique identifier for the job profile.
-
JobProfileType: string
Maximum Length:
80
Type for the job profile. -
LockedFlag: boolean
Maximum Length:
1
Indicates whether a workforce schedule shift is locked for modifications. Valid values are Y and N. The default value is N. -
ObjectVersionNumber: integer
(int32)
Object version number.
-
PersonId: integer
(int64)
Default Value:
-1
Person identifier for the workforce schedule shift assignee. -
PremiumShiftCode: string
Maximum Length:
30
Premium shift code for the scheduled shift type. -
ReferenceDate: string
(date)
Earned date of the workforce schedule shift that spans midnight, or where the shift is part of a shift group with at least 1 shift on the previous or next day.
-
ScheduleId: integer
(int64)
Unique identifier for the workforce schedule containing the shift.
-
ScheduleShiftId: integer
(int64)
Unique identifier for the workforce schedule shift.
-
ScheduleUnitId: integer
(int64)
Unique identifier for the department of workforce schedule shift.
-
ShiftCategory: string
Title:
Shift Category
Maximum Length:30
Shift category. -
ShiftDate: string
(date)
Title:
Date
Date for the workforce schedule shift. -
ShiftId: integer
(int64)
Unique identifier for the enterprise shift.
-
ShiftStartTime: string
Maximum Length:
80
Start time for the workforce schedule shift. -
ShiftType: string
Title:
Shift Type Code
Maximum Length:30
Type for the scheduled shift, such as Regular or On-call. -
ShiftTypeId: integer
(int64)
Title:
Shift Type
Unique identifier for a workforce schedule shift type. -
SkillId: integer
(int64)
Unique identifier for the job the shift applies to.
-
SkipValidationFlag: boolean
Indicates whether the workforce schedule shift needs to be validated.
-
Source: string
Title:
Source
Maximum Length:30
Default Value:ORA_MANUAL
Source for the workforce schedule shift, such as Manual entry or Automatically generated. -
StartDateTime: string
(date-time)
Start date and time for the schedule shift.
-
StartTimeTZOffset: integer
(int32)
Start time for the workforce schedule shift with time zone offset, for example, -360.
-
WorkDuration: integer
(int32)
Title:
Work Duration
Duration, in hours and minutes, for the workforce schedule shift.
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 : workforceSchedules-workerShifts-item-response
Type:
Show Source
object
-
AssignedBy: integer
(int64)
Person who assigned the open shift.
-
AssignmentDate: string
(date-time)
Date when the open shift was assigned.
-
AssignmentId: integer
(int64)
Default Value:
-1
Assignment identifier for the worker scheduled for the shift. -
AssignmentMode: string
Title:
Assignment Source
Maximum Length:30
Method used to assign the shift to the worker. -
AssignmentModeMeaning: string
Title:
Assignment Source
Read Only:true
Maximum Length:80
Method used to assign the shift to the worker. -
BreakDuration: integer
(int32)
Title:
Break Duration
Break duration in minutes. -
Comments: string
Title:
What else do people need to know about this shift?
Maximum Length:4000
Shift notes. -
CompetencyId: integer
Unique identifier for the competency.
-
CompetencyName: string
Title:
Qualification
Read Only:true
Maximum Length:255
Name of the shift competency. -
ContentTypeId: integer
Read Only:
true
Unique identifier for the content type. -
ContentTypeName: string
Read Only:
true
Maximum Length:255
Name of the content type. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Workforce schedule shift creator. -
CreationDate: string
(date-time)
Read Only:
true
Date when the workforce schedule shift was created. -
DeleteFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the workforce schedule shift needs to be deleted. -
EndDateTime: string
(date-time)
Shift end date and time.
-
EndTimeTZOffset: integer
(int32)
End time for the workforce schedule shift with time zone offset, for example, -360.
-
JobProfileCode: string
Maximum Length:
30
Unique identifier for the job profile code. -
JobProfileId: integer
Unique identifier for the job profile.
-
JobProfileName: string
Read Only:
true
Maximum Length:255
Name of the job profile. -
JobProfileType: string
Maximum Length:
80
Type for the job profile. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the workforce schedule shift was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Person who updated the workforce shift. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LockedFlag: boolean
Maximum Length:
1
Indicates whether a workforce schedule shift is locked for modifications. Valid values are Y and N. The default value is N. -
ObjectVersionNumber: integer
(int32)
Object version number.
-
PersonId: integer
(int64)
Default Value:
-1
Person identifier for the workforce schedule shift assignee. -
PremiumShiftCode: string
Maximum Length:
30
Premium shift code for the scheduled shift type. -
Productivity: number
Title:
Productivity Percentage
Read Only:true
Productivity percentage for the scheduled shift type. -
ReferenceDate: string
(date)
Earned date of the workforce schedule shift that spans midnight, or where the shift is part of a shift group with at least 1 shift on the previous or next day.
-
ScheduleId: integer
(int64)
Unique identifier for the workforce schedule containing the shift.
-
ScheduleShiftId: integer
(int64)
Unique identifier for the workforce schedule shift.
-
ScheduleUnitId: integer
(int64)
Unique identifier for the department of workforce schedule shift.
-
ShiftCategory: string
Title:
Shift Category
Maximum Length:30
Shift category. -
ShiftCategoryMeaning: string
Read Only:
true
Maximum Length:255
Meaning for the workforce schedule shift category. -
ShiftDate: string
(date)
Title:
Date
Date for the workforce schedule shift. -
ShiftEndTime: string
Read Only:
true
Maximum Length:255
End time for the workforce schedule shift. -
ShiftId: integer
(int64)
Unique identifier for the enterprise shift.
-
ShiftName: string
Read Only:
true
Maximum Length:240
Name of the workforce schedule shift. -
ShiftStartTime: string
Maximum Length:
80
Start time for the workforce schedule shift. -
ShiftType: string
Title:
Shift Type Code
Maximum Length:30
Type for the scheduled shift, such as Regular or On-call. -
ShiftTypeId: integer
(int64)
Title:
Shift Type
Unique identifier for a workforce schedule shift type. -
ShiftTypeLookupCode: string
Title:
Lookup Code
Read Only:true
Maximum Length:30
Code for the shift type, such as Regular or On-Call -
ShiftTypeMeaning: string
Title:
Shift Type
Read Only:true
Maximum Length:80
Meaning for the scheduled shift type, such as Regular or On-call. -
SkillId: integer
(int64)
Unique identifier for the job the shift applies to.
-
SkipValidationFlag: boolean
Indicates whether the workforce schedule shift needs to be validated.
-
Source: string
Title:
Source
Maximum Length:30
Default Value:ORA_MANUAL
Source for the workforce schedule shift, such as Manual entry or Automatically generated. -
SourceMeaning: string
Title:
Source
Read Only:true
Maximum Length:80
Source for the workforce schedule shift, such as Manual entry or Automatically generated. -
StartDateTime: string
(date-time)
Start date and time for the schedule shift.
-
StartTimeTZOffset: integer
(int32)
Start time for the workforce schedule shift with time zone offset, for example, -360.
-
WorkDuration: integer
(int32)
Title:
Work Duration
Duration, in hours and minutes, for the workforce schedule shift.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.