Get a single workforce schedule for the specified unit or assignment and day
get
/hcmRestApi/resources/11.13.18.05/workforceSchedules/{ScheduleId}
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=
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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-item-response
Type:
Show Source
object
-
Comments: string
Maximum Length:
4000
Schedule notes. -
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. -
DeleteOpenShiftsFlag: boolean
Maximum Length:
80
Option on the publish drawer to delete all open shifts in the period. -
Discriminator: integer
Determines the source of populated information, only for internal use.
-
EndDate: string
(date)
End date for the workforce schedule period.
-
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 schedule. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
User name for the person who updated the workforce schedule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Object version number.
-
OpenDate: string
(date)
Open date for the workforce schedule generation period.
-
PublishDueDate: string
(date)
Publish due date for the workforce schedule.
-
PublishedBy: integer
Person who published the workforce schedule.
-
PublishedDate: string
(date)
Date when the workforce schedule was published.
-
SchedGenProfileId: integer
Foreign key reference to the schedule generation profile.
-
ScheduleId: integer
Unique identifier for the workforce schedule containing the shift.
-
ScheduleUnitId: integer
Foreign key reference to the workforce schedule department.
-
ScheduleUpdateDate: string
(date-time)
Date when the workforce schedule was updated.
-
SelfScheduleCloseDate: string
(date)
Date when the self-scheduling window closes.
-
SelfScheduleOpenDate: string
(date)
Date when the self-scheduling window opens.
-
StartDate: string
(date)
Start date for the workforce schedule.
-
StatusCode: string
Maximum Length:
30
Status code for the workforce schedules. -
workerShifts: array
Schedule Shifts Migration
Title:
Schedule Shifts Migration
The workerShifts resource provides information about the workforce schedule shifts. It lets schedulers view and manage schedules for a given period, open shifts, and worker assignments. -
WorkloadUpdateDate: string
(date-time)
Date when the workload was updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Schedule Shifts Migration
Type:
array
Title:
Schedule Shifts Migration
The workerShifts resource provides information about the workforce schedule shifts. It lets schedulers view and manage schedules for a given period, open shifts, and worker assignments.
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 : 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
Links
- claimShift
-
Parameters:
- ScheduleId:
$request.path.ScheduleId
Claims an open shift matching the criteria, to one of their assignments. - ScheduleId:
- createOpenShifts
-
Operation: /hcmRestApi/resources/11.13.18.05/workforceSchedules/{ScheduleId}/action/createOpenShiftsParameters:
- ScheduleId:
$request.path.ScheduleId
Creates workforce schedule open shifts for the specified workforce schedule. - ScheduleId:
- dropShift
-
Parameters:
- ScheduleId:
$request.path.ScheduleId
Drops an assigned shift with the specified schedule shift ID after the schedule is published. - ScheduleId:
- shiftConflicts
-
Parameters:
- ScheduleId:
$request.path.ScheduleId
Lists the conflicts for an open shift. - ScheduleId:
- validateSchedule
-
Operation: /hcmRestApi/resources/11.13.18.05/workforceSchedules/{ScheduleId}/action/validateScheduleParameters:
- ScheduleId:
$request.path.ScheduleId
Runs full schedule validation for a schedule period. - ScheduleId:
- weeklyTotals
-
Parameters:
- ScheduleId:
$request.path.ScheduleId
Gets the weekly scheduled and contracted hours for the signed in worker. - ScheduleId:
- withdrawShift
-
Parameters:
- ScheduleId:
$request.path.ScheduleId
Withdraws the claimed shift with the specified schedule shift ID during the self-scheduling period. - ScheduleId:
- workerShifts
-
Parameters:
- ScheduleId:
$request.path.ScheduleId
The workerShifts resource provides information about the workforce schedule shifts. It lets schedulers view and manage schedules for a given period, open shifts, and worker assignments. - ScheduleId: