Jump to

• Request
• Response
• Examples

Get one shift

get

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

Request

Path Parameters

• ShiftId(required): integer(int64)
  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

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

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.

Body ()

Root Schema : shifts-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The abbreviation that identifies the shift categories, such as working from home or office.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShiftDetailTypeCode":{
            "title":"Shift Detail Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the shift that you provide when creating an instance.",
            "nullable":true,
            "x-queryable":true
        },
        "EndTime":{
            "maxLength":255,
            "type":"string",
            "description":"The time when the shift ends. The text is formatted as \"hh:mm AM/PM\".",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartTime":{
            "maxLength":255,
            "type":"string",
            "description":"The time when the shift starts. The text is formatted as \"hh:mm AM/PM\".",
            "nullable":true,
            "x-queryable":true
        },
        "ShiftId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Duration":{
            "type":"number",
            "description":"The value that identifies the duration of the shift.",
            "nullable":true,
            "x-queryable":true
        },
        "Code":{
            "title":"Code",
            "maxLength":3,
            "type":"string",
            "description":"The abbreviation that identifies the shift.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the shift that you provide when creating an instance. This attribute is required.",
            "nullable":false,
            "x-queryable":true
        },
        "ShiftTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The abbreviation that identifies the type of shift being created. Valid values are Time, Duration, and Elapsed. This attribute is required.",
            "nullable":false,
            "x-queryable":true
        },
        "shiftDetails":{
            "title":"Shift Details",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/shifts-shiftDetails-item-response"
            }
        },
        "DurationUnit":{
            "title":"Duration Unit",
            "maxLength":30,
            "type":"string",
            "description":"The unit of time to associate with the time-duration value.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PeriodTypeCode":{
            "title":"Period Type",
            "maxLength":30,
            "type":"string",
            "description":"The abbreviation that identifies the shift duration, such as work period or off period.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : 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

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

{
    "title":"Shift Details",
    "type":"array",
    "description":"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.",
    "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

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShiftDetailsId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartTime":{
            "type":"string",
            "description":"The time when the shift detail starts. The text is formatted as \"hh:mm AM/PM\".",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumBreakMinutes":{
            "type":"integer",
            "description":"The maximum number of minutes that you may take as a break in the shift detail.",
            "nullable":true,
            "x-queryable":true
        },
        "Duration":{
            "type":"number",
            "description":"The value that identifies the duration of the shift detail.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the shift detail.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DurationUnit":{
            "title":"Duration Unit",
            "maxLength":30,
            "type":"string",
            "description":"The unit of time to associate with the time-duration value.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MinimumBreakMinutes":{
            "type":"integer",
            "description":"The minimum number of minutes that you may take as a break in the shift detail.",
            "nullable":true,
            "x-queryable":true
        },
        "Day":{
            "type":"integer",
            "description":"The day of the shift detail when shifts are longer than 24 hours in length.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CoreWorkFlag":{
            "title":"Core Work",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        }
    }
}

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

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