Create shifts
post
/fscmRestApi/resources/11.13.18.05/shifts
Request
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
-
CategoryCode: string
Title:
Category
Maximum Length:30
The abbreviation that identifies the shift categories, such as working from home or office. -
Code: string
Title:
Code
Maximum Length:3
The abbreviation that identifies the shift. -
Description: string
Title:
Description
Maximum Length:2000
The description of the shift that you provide when creating an instance. -
Duration: number
The value that identifies the duration of the shift.
-
DurationUnit(required): string
Title:
Duration Unit
Maximum Length:30
The unit of time to associate with the time-duration value. -
Name(required): string
Title:
Name
Maximum Length:240
The name of the shift that you provide when creating an instance. This attribute is required. -
PeriodTypeCode: string
Title:
Period Type
Maximum Length:30
The abbreviation that identifies the shift duration, such as work period or off period. -
shiftDetails: array
Shift Details
Title:
Shift Details
The Shift Details resource gets the collection of time segments that decompose the working time of the Shift. Only Time shifts that are of type Flexible or Punch have shift details. -
ShiftDetailTypeCode: string
Title:
Shift Detail Type
Maximum Length:30
The abbreviation that identifies the type of Time shift being created. Valid values are Flexible, Punch, and None. This attribute is required for Time shifts. -
ShiftTypeCode(required): string
Title:
Type
Maximum Length:30
The abbreviation that identifies the type of shift being created. Valid values are Time, Duration, and Elapsed. This attribute is required. -
StartTime: string
Maximum Length:
255
The time when the shift starts. The text is formatted as "hh:mm AM/PM".
Nested Schema : Shift Details
Type:
array
Title:
Shift Details
The Shift Details resource gets the collection of time segments that decompose the working time of the Shift. Only Time shifts that are of type Flexible or Punch have shift details.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
CoreWorkFlag: boolean
Title:
Core Work
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then the shift detail is core working time. If false, then the shift detail is not core working time. The default value is false. -
Day: integer
The day of the shift detail when shifts are longer than 24 hours in length.
-
Duration: number
The value that identifies the duration of the shift detail.
-
DurationUnit: string
Title:
Duration Unit
Maximum Length:30
The unit of time to associate with the time-duration value. -
MaximumBreakMinutes: integer
The maximum number of minutes that you may take as a break in the shift detail.
-
MinimumBreakMinutes: integer
The minimum number of minutes that you may take as a break in the shift detail.
-
Name: string
Title:
Name
Maximum Length:30
The name of the shift detail. -
StartTime: string
The time when the shift detail starts. The text is formatted as "hh:mm AM/PM".
Response
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 : shifts-item-response
Type:
Show Source
object
-
CategoryCode: string
Title:
Category
Maximum Length:30
The abbreviation that identifies the shift categories, such as working from home or office. -
Code: string
Title:
Code
Maximum Length:3
The abbreviation that identifies the shift. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the user created the record. -
Description: string
Title:
Description
Maximum Length:2000
The description of the shift that you provide when creating an instance. -
Duration: number
The value that identifies the duration of the shift.
-
DurationUnit: string
Title:
Duration Unit
Maximum Length:30
The unit of time to associate with the time-duration value. -
EndTime: string
Read Only:
true
Maximum Length:255
The time when the shift ends. The text is formatted as "hh:mm AM/PM". -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:240
The name of the shift that you provide when creating an instance. This attribute is required. -
PeriodTypeCode: string
Title:
Period Type
Maximum Length:30
The abbreviation that identifies the shift duration, such as work period or off period. -
shiftDetails: array
Shift Details
Title:
Shift Details
The Shift Details resource gets the collection of time segments that decompose the working time of the Shift. Only Time shifts that are of type Flexible or Punch have shift details. -
ShiftDetailTypeCode: string
Title:
Shift Detail Type
Maximum Length:30
The abbreviation that identifies the type of Time shift being created. Valid values are Flexible, Punch, and None. This attribute is required for Time shifts. -
ShiftId: integer
(int64)
Read Only:
true
The value that uniquely identifies the shift. It is a primary key that the application generates when it creates a shift. This attribute is required. -
ShiftTypeCode: string
Title:
Type
Maximum Length:30
The abbreviation that identifies the type of shift being created. Valid values are Time, Duration, and Elapsed. This attribute is required. -
StartTime: string
Maximum Length:
255
The time when the shift starts. The text is formatted as "hh:mm AM/PM".
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Shift Details
Type:
array
Title:
Shift Details
The Shift Details resource gets the collection of time segments that decompose the working time of the Shift. Only Time shifts that are of type Flexible or Punch have shift details.
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 : shifts-shiftDetails-item-response
Type:
Show Source
object
-
CoreWorkFlag: boolean
Title:
Core Work
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then the shift detail is core working time. If false, then the shift detail is not core working time. The default value is false. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the user created the record. -
Day: integer
The day of the shift detail when shifts are longer than 24 hours in length.
-
Duration: number
The value that identifies the duration of the shift detail.
-
DurationUnit: string
Title:
Duration Unit
Maximum Length:30
The unit of time to associate with the time-duration value. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumBreakMinutes: integer
The maximum number of minutes that you may take as a break in the shift detail.
-
MinimumBreakMinutes: integer
The minimum number of minutes that you may take as a break in the shift detail.
-
Name: string
Title:
Name
Maximum Length:30
The name of the shift detail. -
ShiftDetailsId: integer
(int64)
Read Only:
true
The value that uniquely identifies the shift detail. It is a primary key that the application generates when it creates a shift detail. This attribute is required. -
StartTime: string
The time when the shift detail starts. The text is formatted as "hh:mm AM/PM".
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- shiftDetails
-
Parameters:
- ShiftId:
$request.path.ShiftId
The Shift Details resource gets the collection of time segments that decompose the working time of the Shift. Only Time shifts that are of type Flexible or Punch have shift details. - ShiftId:
Examples
This example describes how to create shifts.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/shifts"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "Name" : "SHIFT-Example", "Description" : "Shift Example of Post", "Code" : "", "StartTime" : "09:00 AM", "Duration" : 8, "DurationUnit" : "HOURS", "CategoryCode" : "WORK_FROM_OFFICE", "PeriodTypeCode" : "WORK_PERIOD", "ShiftTypeCode" : "TIME", "ShiftDetailTypeCode" : "NONE" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "ShiftId" : 300100111082919, "Name" : "SHIFT-Example", "Description" : "Shift Example of Post", "Code" : "", "StartTime" : "09:00 AM", "EndTime" : "17:00", "Duration" : 8, "DurationUnit" : "HOURS", "CategoryCode" : "WORK_FROM_OFFICE", "PeriodTypeCode" : "WORK_PERIOD", "ShiftTypeCode" : "TIME", "ShiftDetailTypeCode" : "NONE", "links" : [ ... ] }