Get a shift
get
/hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}/child/shifts/{shiftsUniqID}
Request
Path Parameters
-
availabilityPatternsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the (availabilityPatterns) resource and used to uniquely identify an instance of (availabilityPatterns). The client should not generate the hash key value. Instead, the client should query on the (availabilityPatterns) collection resource in order to navigate to a specific instance of (availabilityPatterns) to get the hash key.
-
shiftsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the (shifts) resource and used to uniquely identify an instance of (shifts). The client should not generate the hash key value. Instead, the client should query on the (shifts) collection resource in order to navigate to a specific instance of (shifts) to get the hash key.
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 : availabilityPatterns-shifts-item-response
Type:
Show Source
object
-
AssignmentAvailabilityId: integer
(int64)
Unique identifier of the availability pattern.
-
AvailabilityDetailId: integer
(int64)
Unique identifier of the shift in an availability pattern.
-
breaks: array
Breaks
Title:
Breaks
The breaks resource is a child of the shifts resource. It includes a list of all of the breaks that an employee can take during a shift. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who created the shift. -
CreationDate: string
(date-time)
Read Only:
true
Date when the shift was created. -
DayOfWeek: string
Number specifying the day of the week, or day of the cycle for multiweek patterns. For example, 1 for Sunday, 2 for Monday, 8 for the Monday of the second week, 14 for the Saturday for the second week.
-
Duration: string
Duration of the shift in hours. Value must be between 0 and 24. For example, 8.
-
EndTime: string
Time when a shift ends, entered in HH24:MI format. For example, 21:00.
-
ExceptionDate: string
(date)
Date when an exception applies.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the shift was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who last updated the shift. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Unique identifier of the last update login. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NonWorkExceptionFlag: boolean
Maximum Length:
255
Default Value:false
Indicates weather the flag for the exception shift represents a nonworking day. Possible values are true and false. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried. -
PatternException: string
Maximum Length:
255
Type differentiating a pattern from an exception. Possible values are PATTERN and EXCEPTION. -
StartTime: string
Time when a shift starts, entered in HH24:MI format. For example, 14:00.
Nested Schema : Breaks
Type:
array
Title:
Breaks
The breaks resource is a child of the shifts resource. It includes a list of all of the breaks that an employee can take during a shift.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : availabilityPatterns-shifts-breaks-item-response
Type:
Show Source
object
-
AssignmentAvailabilityId: integer
(int64)
Unique identifier of the availability pattern.
-
AvailabilityDetailId: integer
(int64)
Unique identifier of the break belonging to a shift in an availability pattern.
-
BreakId: integer
(int64)
Unique identifier of the break.
-
BreakName: string
Maximum Length:
240
Name of the break, as identified in availability type setup, for example, Lunch or Tea. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who created the break. -
CreationDate: string
(date-time)
Read Only:
true
Date when the break was created. -
Duration: string
Duration of the break in minutes, for example, 15 or 30.
-
EndTime: string
Time when a break ends, entered in HH24:MI format, for example, 14:30.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the break was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who last updated the break. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Unique identifier of the last update login. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried. -
StartTime: string
Time when a break starts, entered in HH24:MI format, for example, 14:30.
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
- breaks
-
Parameters:
- availabilityPatternsUniqID:
$request.path.availabilityPatternsUniqID
- shiftsUniqID:
$request.path.shiftsUniqID
The breaks resource is a child of the shifts resource. It includes a list of all of the breaks that an employee can take during a shift. - availabilityPatternsUniqID: