Create a collection of workforce schedule shifts for selected unit for a period
post
/hcmRestApi/resources/11.13.18.05/scheduleShifts
Request
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
-
AssignmentId: integer
(int64)
Assignment ID for the worker that the workforce shift is scheduled for.
-
AssignmentMode: string
Maximum Length:
30
Assignment mode of the workforce schedule shift, such as Manual and Autogenerated. -
BreakDuration: integer
(int32)
Workforce schedule shift break duration.
-
Comments: string
Maximum Length:
4000
Comments. -
EndDateTime: string
(date-time)
Date and time when the shift can't be used when generating workforce schedules.
-
EndTimeTZOffset: integer
(int32)
End time of the workforce schedule shift with time zone offset.
-
LockedFlag: boolean
Maximum Length:
1
Identifies if a workforce schedule shift is locked for modifications. -
ObjectVersionNumber: integer
(int32)
Internal object version number.
-
PersonId: integer
(int64)
Unique identifier for the worker assigned to a workforce schedule shift.
-
ReferenceDate: string
(date)
Earned date of the workforce schedule shift that spans midnight or 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 or unit the workforce schedule shift is for.
-
ShiftCategoryCode: string
Maximum Length:
30
Workforce schedule shift category code. -
ShiftId: integer
(int64)
Unique identifier for the enterprise workforce schedule shift.
-
SkillId: integer
(int64)
Foreign key reference to the job skills table.
-
Source: string
Maximum Length:
30
Source of the workforce schedule shift, such as Manual entry and Autogenerated. -
StartDateTime: string
(date-time)
Start date timestamp of the Schedule shift
-
StartTimeTZOffset: integer
(int32)
Start time of the workforce schedule shift with time zone offset.
-
WorkDuration: integer
(int32)
Duration of the workforce schedule shift in hours and minutes.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : scheduleShifts-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Assignment ID for the worker that the workforce shift is scheduled for.
-
AssignmentMode: string
Maximum Length:
30
Assignment mode of the workforce schedule shift, such as Manual and Autogenerated. -
AssignmentWeeklyFTEHrs: integer
Read Only:
true
Assignment weekly hours from FTE. -
BreakDuration: integer
(int32)
Workforce schedule shift break duration.
-
Comments: string
Maximum Length:
4000
Comments. -
CompetencyId: integer
(int64)
Read Only:
true
Competency unique identifier. -
CompetencyName: string
Read Only:
true
Maximum Length:255
Competency name. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User ID for the person who created the workforce schedule shift. -
CreationDate: string
(date-time)
Read Only:
true
Date when the workforce schedule shift was created. -
EndDateTime: string
(date-time)
Date and time when the shift can't be used when generating workforce schedules.
-
EndTimeTZOffset: integer
(int32)
End time of the workforce schedule shift with time zone offset.
-
JobProfileId: integer
(int64)
Read Only:
true
Job profile unique identifier. -
JobProfileName: string
Read Only:
true
Maximum Length:255
Job profile name. -
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
User ID for the schedule manager who updated the workforce shift. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LockedFlag: boolean
Maximum Length:
1
Identifies if a workforce schedule shift is locked for modifications. -
ObjectVersionNumber: integer
(int32)
Internal object version number.
-
PersonId: integer
(int64)
Unique identifier for the worker assigned to a workforce schedule shift.
-
ReferenceDate: string
(date)
Earned date of the workforce schedule shift that spans midnight or 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 or unit the workforce schedule shift is for.
-
ShiftCategory: string
Read Only:
true
Maximum Length:255
Workforce schedule shift category. -
ShiftCategoryCode: string
Maximum Length:
30
Workforce schedule shift category code. -
ShiftId: integer
(int64)
Unique identifier for the enterprise workforce schedule shift.
-
ShiftName: string
Read Only:
true
Maximum Length:240
Name of the workforce schedule shift. -
SkillId: integer
(int64)
Foreign key reference to the job skills table.
-
Source: string
Maximum Length:
30
Source of the workforce schedule shift, such as Manual entry and Autogenerated. -
StartDateTime: string
(date-time)
Start date timestamp of the Schedule shift
-
StartTimeTZOffset: integer
(int32)
Start time of the workforce schedule shift with time zone offset.
-
WorkDuration: integer
(int32)
Duration of the workforce schedule shift in hours and minutes.
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.