Create a break
post
/hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}/child/shifts/{shiftsUniqID}/child/breaks
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.
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
-
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. -
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.
-
StartTime: string
Time when a break starts, entered in HH24:MI format, for example, 14:30.
Response
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-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.