Get all calendar shifts
get
/fscmRestApi/resources/11.13.18.05/calendarShifts
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds a calendar shift that matches the primary key.
Finder Variables- CalendarCode; string; Finds a calendar shift that matches the primary key and calendar code.
- ExceptionStartDate; string; Finds a calendar shift that matches the primary key and exception start date.
- Sequence; integer; Finds a calendar shift that matches the primary key and sequence.
- ShiftNumber; integer; Finds a calendar shift that matches the primary key and shift number.
- PrimaryKey Finds a calendar shift that matches the primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- Calendar; string; Name of the workday calendar.
- CalendarCode; string; Unique identifier for the calendar in the source system.
- EndTime; string; Time that the shift ends. Shift times can't overlap. Enter time in seconds.
- ExceptionEndDate; string; Last date till which any exception in the calendar is valid. This date must be within the calendar start date and end date.
- ExceptionStartDate; string; Start date from which the exception in the calendar is valid. This date must be within the calendar start date and end date.
- ExceptionType; integer; Code for the exception type. Valid values are 1 - Available and 2 - Not Available.
- ExceptionTypeName; string; Name of the exception type. For example, Available, or Not Available.
- Sequence; integer; Sequence number of the date on a calendar.
- ShiftDaysOff; integer; Number of consecutive nonworking days.
- ShiftDaysOn; integer; Number of consecutive working days.
- ShiftName; string; Name of the calendar shift.
- ShiftNumber; integer; Number of the calendar shift.
- StartTime; string; Time from which the shift starts. Shift times can't overlap. Enter time in seconds.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 TopResponse
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 : calendarShifts
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : calendarShifts-item-response
Type:
Show Source
object
-
Calendar: string
Title:
Calendar
Read Only:true
Maximum Length:240
Name of the workday calendar. -
CalendarCode: string
Title:
ID
Read Only:true
Maximum Length:255
Unique identifier for the calendar in the source system. -
EndTime: string
Title:
End Time
Read Only:true
Time that the shift ends. Shift times can't overlap. Enter time in seconds. -
ExceptionEndDate: string
(date)
Title:
Shift Exception End Date
Read Only:true
Last date till which any exception in the calendar is valid. This date must be within the calendar start date and end date. -
ExceptionStartDate: string
(date)
Title:
Shift Exception Start Date
Read Only:true
Start date from which the exception in the calendar is valid. This date must be within the calendar start date and end date. -
ExceptionType: integer
Title:
Exception Type Code
Read Only:true
Code for the exception type. Valid values are 1 - Available and 2 - Not Available. -
ExceptionTypeName: string
Title:
Exception Type
Read Only:true
Maximum Length:4000
Name of the exception type. For example, Available, or Not Available. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Sequence: integer
(int64)
Title:
Sequence
Read Only:true
Sequence number of the date on a calendar. -
ShiftDaysOff: integer
Title:
Shift Days Off
Read Only:true
Number of consecutive nonworking days. -
ShiftDaysOn: integer
Title:
Shift Days On
Read Only:true
Number of consecutive working days. -
ShiftName: string
Title:
Shift Name
Read Only:true
Maximum Length:80
Name of the calendar shift. -
ShiftNumber: integer
Title:
Shift Number
Read Only:true
Number of the calendar shift. -
StartTime: string
Title:
Start Time
Read Only:true
Time from which the shift starts. Shift times can't overlap. Enter time in seconds.
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.