1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. SCM Common
  4. Shifts

Get one shift

get

/fscmRestApi/resources/11.13.18.05/shifts/{ShiftId}

Request

Path Parameters
  • 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.
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
  • Title: Category
    Maximum Length: 30
    The abbreviation that identifies the shift categories, such as working from home or office.
  • Title: Code
    Maximum Length: 3
    The abbreviation that identifies the shift.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the record.
  • Title: Creation Date
    Read Only: true
    Date and time when the user created the record.
  • Title: Description
    Maximum Length: 2000
    The description of the shift that you provide when creating an instance.
  • The value that identifies the duration of the shift.
  • Title: Duration Unit
    Maximum Length: 30
    The unit of time to associate with the time-duration value.
  • Read Only: true
    Maximum Length: 255
    The time when the shift ends. The text is formatted as "hh:mm AM/PM".
  • Title: Last Updated Date
    Read Only: true
    Date and time when the user most recently updated the record.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • Title: Name
    Maximum Length: 240
    The name of the shift that you provide when creating an instance. This attribute is required.
  • Title: Period Type
    Maximum Length: 30
    The abbreviation that identifies the shift duration, such as work period or off period.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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 : shifts-shiftDetails-item-response
Type: object
Show Source
  • 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.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the record.
  • Title: Creation Date
    Read Only: true
    Date and time when the user created the record.
  • The day of the shift detail when shifts are longer than 24 hours in length.
  • The value that identifies the duration of the shift detail.
  • Title: Duration Unit
    Maximum Length: 30
    The unit of time to associate with the time-duration value.
  • Title: Last Updated Date
    Read Only: true
    Date and time when the user most recently updated the record.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • The maximum number of minutes that you may take as a break in the shift detail.
  • The minimum number of minutes that you may take as a break in the shift detail.
  • Title: Name
    Maximum Length: 30
    The name of the shift detail.
  • 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.
  • The time when the shift detail starts. The text is formatted as "hh:mm AM/PM".
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.
Back to Top

Examples

This example describes how to get one shift.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "server/fscmRestApi/resources/release_number/shifts?finder=PrimaryKey;ShiftId=ShiftId"

For example, the following command gets shift where the shift identifier is 4011:

curl -u username:password "server/fscmRestApi/resources/release_number/shifts?finder=PrimaryKey;ShiftId=999990012722001"

Example Response Body

The following shows an example of the response body in JSON format.

{
  "items" : [ {
    "ShiftId" : 999990012722001,
    "Name" : "9-5 Time Shift",
    "Description" : "shift desc",
    "Code" : "ABC",
    "StartTime" : "09:00",
    "EndTime" : "17:00",
    "Duration" : 8,
    "DurationUnit" : "HOURS",
    "CategoryCode" : "WORK_FROM_OFFICE",
    "PeriodTypeCode" : "WORK_PERIOD",
    "ShiftTypeCode" : "TIME",
    "ShiftDetailTypeCode" : "PUNCH",
...
  } ],
...
}
Back to Top