Get a collection of workforce schedule shifts for the specified unit and period
get
/hcmRestApi/resources/11.13.18.05/scheduleShifts
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds a workforce schedule shift with the specified unique identifier.
Finder Variables- ScheduleShiftId; integer; Unique identifier for a workforce schedule shift
- PrimaryKey Finds a workforce schedule shift with the specified unique identifier.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AssignmentId; integer; Assignment ID for the worker that the workforce shift is scheduled for.
- AssignmentMode; string; Assignment mode of the workforce schedule shift, such as Manual and Autogenerated.
- AssignmentWeeklyFTEHrs; integer; Assignment weekly hours from FTE.
- BreakDuration; integer; Workforce schedule shift break duration.
- Comments; string; Comments.
- CompetencyId; integer; Competency unique identifier.
- CompetencyName; string; Competency name.
- CreatedBy; string; User ID for the person who created the workforce schedule shift.
- CreationDate; string; Date when the workforce schedule shift was created.
- EndDateTime; string; Date and time when the shift can't be used when generating workforce schedules.
- EndTimeTZOffset; integer; End time of the workforce schedule shift with time zone offset.
- JobProfileId; integer; Job profile unique identifier.
- JobProfileName; string; Job profile name.
- LastUpdateDate; string; Date when the workforce schedule shift was most recently updated.
- LastUpdatedBy; string; User ID for the schedule manager who updated the workforce shift.
- LockedFlag; boolean; Identifies if a workforce schedule shift is locked for modifications.
- ObjectVersionNumber; integer; Internal object version number.
- PersonId; integer; Unique identifier for the worker assigned to a workforce schedule shift.
- ReferenceDate; string; 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; Unique identifier for the workforce schedule containing the shift.
- ScheduleShiftId; integer; Unique identifier for the workforce schedule shift.
- ScheduleUnitId; integer; Unique identifier for the department or unit the workforce schedule shift is for.
- ShiftCategoryCode; string; Workforce schedule shift category code.
- ShiftId; integer; Unique identifier for the enterprise workforce schedule shift.
- ShiftName; string; Name of the workforce schedule shift.
- SkillId; integer; Foreign key reference to the job skills table.
- Source; string; Source of the workforce schedule shift, such as Manual entry and Autogenerated.
- StartDateTime; string; Start date timestamp of the Schedule shift
- StartTimeTZOffset; integer; Start time of the workforce schedule shift with time zone offset.
- WorkDuration; integer; Duration of the workforce schedule shift in hours and minutes.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : scheduleShifts
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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.
Links
- findByAdvancedSearchQuery
-
Finds the workforce schedule shifts that match the specified criteria, such as name or code.
- getFilterValues
-
Finds the workforce schedule shifts that match the specified criteria.