Get a single workforce schedule shift for the specified unit or assignment and day
get
/hcmRestApi/resources/11.13.18.05/workforceSchedules/{ScheduleId}/child/workerShifts/{ScheduleShiftId}
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=
-
ScheduleShiftId(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=
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(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 : workforceSchedules-workerShifts-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Assignment identifier for the worker scheduled for the shift.
-
AssignmentMode: string
Maximum Length:
30
Method used to assign the shift to the worker. -
BreakDuration: integer
(int32)
Break duration in minutes.
-
Comments: string
Maximum Length:
4000
Shift notes. -
CompetencyId: integer
Competency unique identifier.
-
CompetencyName: string
Read Only:
true
Maximum Length:80
Competency Name -
CreatedBy: string
Read Only:
true
Maximum Length:64
Person who created the workforce schedule shift. -
CreationDate: string
(date-time)
Read Only:
true
Date when the workforce schedule shift was created. -
DeleteFlag: boolean
Maximum Length:
1
Default Value:false
Indicates if the workforce schedule shift needs to be deleted. -
EndDateTime: string
(date-time)
Shift end date and time.
-
EndTimeTZOffset: integer
(int32)
End time of the workforce schedule shift with time zone offset.
-
JobProfileId: integer
Job profile unique identifier.
-
JobProfileName: string
Read Only:
true
Maximum Length:80
Job profile name -
JobProfileType: string
Maximum Length:
80
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
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)
Person identifier for the worker assigned to a workforce schedule shift.
-
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
Maximum Length:
30
Shift category. -
ShiftCategoryMeaning: string
Read Only:
true
Maximum Length:80
Workforce schedule shift category meaning. -
ShiftDate: string
(date)
Date of the workforce schedule shift.
-
ShiftEndTime: string
Maximum Length:
80
End time of the workforce schedule shift. -
ShiftId: integer
(int64)
Unique identifier for the enterprise shift.
-
ShiftName: string
Read Only:
true
Maximum Length:80
Name of the workforce schedule shift. -
ShiftStartTime: string
Maximum Length:
80
Start time of the workforce schedule shift. -
SkillId: integer
(int64)
Unique identifier for the job used in the shift.
-
Source: string
Maximum Length:
30
Source of the workforce schedule shift, such as manual entry or automatically generated by the workforce schedules generation process. -
StartDateTime: string
(date-time)
Start date and time for the schedule shift.
-
StartTimeTZOffset: integer
(int32)
Start time of the workforce schedule shift with time zone offset.
-
WorkDuration: integer
(int32)
Duration of the 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.