Jump to

• Request
• Response
• Examples

Create

post

/fscmRestApi/resources/11.13.18.05/shifts

Request

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CategoryCode: string
  Title: Category

  Maximum Length: 30
• Code: string
  Title: Code

  Maximum Length: 3
• Description: string
  Title: Description

  Maximum Length: 2000
• Duration: number
• DurationUnit(required): string
  Title: Duration Unit

  Maximum Length: 30
• HCMScheduleShiftId: integer (int64)
• Name(required): string
  Title: Name

  Maximum Length: 240
• PeriodTypeCode: string
  Title: Period Type

  Maximum Length: 30
• shiftDetails: array shiftDetails
• ShiftDetailTypeCode: string
  Title: Shift Detail Type

  Maximum Length: 30
• ShiftTypeCode(required): string
  Title: Type

  Maximum Length: 30
• StartTime: string
  Maximum Length: 255

{
    "required":[
        "DurationUnit",
        "Name",
        "ShiftTypeCode"
    ],
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Code":{
            "title":"Code",
            "maxLength":3,
            "type":"string",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "nullable":true
        },
        "Duration":{
            "type":"number",
            "nullable":true
        },
        "DurationUnit":{
            "title":"Duration Unit",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "HCMScheduleShiftId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "nullable":false
        },
        "PeriodTypeCode":{
            "title":"Period Type",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ShiftDetailTypeCode":{
            "title":"Shift Detail Type",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ShiftTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "nullable":false
        },
        "StartTime":{
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "shiftDetails":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shifts-shiftDetails-item-post-request"
            }
        }
    }
}

Nested Schema : shiftDetails

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shifts-shiftDetails-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• CoreWorkFlag: boolean
  Title: Core Work

  Maximum Length: 1

  Default Value: false
• Day: integer
• Duration: number
• DurationUnit: string
  Title: Duration Unit

  Maximum Length: 30
• MaximumBreakMinutes: integer
• MinimumBreakMinutes: integer
• Name: string
  Title: Name

  Maximum Length: 30
• StartTime: string

{
    "type":"object",
    "properties":{
        "CoreWorkFlag":{
            "title":"Core Work",
            "maxLength":1,
            "type":"boolean",
            "nullable":false,
            "default":false
        },
        "Day":{
            "type":"integer",
            "nullable":true
        },
        "Duration":{
            "type":"number",
            "nullable":true
        },
        "DurationUnit":{
            "title":"Duration Unit",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MaximumBreakMinutes":{
            "type":"integer",
            "nullable":true
        },
        "MinimumBreakMinutes":{
            "type":"integer",
            "nullable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StartTime":{
            "type":"string",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : shifts-item-response

Type: object

Show Source

• CategoryCode: string
  Title: Category

  Maximum Length: 30
• Code: string
  Title: Code

  Maximum Length: 3
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true
• Description: string
  Title: Description

  Maximum Length: 2000
• Duration: number
• DurationUnit: string
  Title: Duration Unit

  Maximum Length: 30
• EndTime: string
  Read Only: true

  Maximum Length: 255
• HCMScheduleShiftCode: string
  Read Only: true

  Maximum Length: 255
• HCMScheduleShiftId: integer (int64)
• HCMScheduleShiftName: string
  Read Only: true

  Maximum Length: 255
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 240
• PeriodTypeCode: string
  Title: Period Type

  Maximum Length: 30
• shiftDetails: array shiftDetails
• ShiftDetailTypeCode: string
  Title: Shift Detail Type

  Maximum Length: 30
• ShiftId: integer (int64)
  Read Only: true
• ShiftTypeCode: string
  Title: Type

  Maximum Length: 30
• StartTime: string
  Maximum Length: 255

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Code":{
            "title":"Code",
            "maxLength":3,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "Duration":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "DurationUnit":{
            "title":"Duration Unit",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndTime":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HCMScheduleShiftCode":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HCMScheduleShiftId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HCMScheduleShiftName":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodTypeCode":{
            "title":"Period Type",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ShiftDetailTypeCode":{
            "title":"Shift Detail Type",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ShiftId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShiftTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "StartTime":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "shiftDetails":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shifts-shiftDetails-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : shiftDetails

Type: array

Show Source

• Array of: object shifts-shiftDetails-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shifts-shiftDetails-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : shifts-shiftDetails-item-response

Type: object

Show Source

• CoreWorkFlag: boolean
  Title: Core Work

  Maximum Length: 1

  Default Value: false
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true
• Day: integer
• Duration: number
• DurationUnit: string
  Title: Duration Unit

  Maximum Length: 30
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumBreakMinutes: integer
• MinimumBreakMinutes: integer
• Name: string
  Title: Name

  Maximum Length: 30
• ShiftDetailsId: integer (int64)
  Read Only: true
• StartTime: string

{
    "type":"object",
    "properties":{
        "CoreWorkFlag":{
            "title":"Core Work",
            "maxLength":1,
            "type":"boolean",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Day":{
            "type":"integer",
            "nullable":true,
            "x-queryable":true
        },
        "Duration":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "DurationUnit":{
            "title":"Duration Unit",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumBreakMinutes":{
            "type":"integer",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumBreakMinutes":{
            "type":"integer",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ShiftDetailsId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartTime":{
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

shiftDetails

Operation: /fscmRestApi/resources/11.13.18.05/shifts/{ShiftId}/child/shiftDetails

Parameters:

• ShiftId: $request.path.ShiftId

Back to Top

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" : [ ... ] 
} 

Back to Top