Get all work schedules
get
/fscmRestApi/resources/11.13.18.05/publicSectorWorkSchedules
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 the work schedule that matches the primary key criteria specified.
Finder Variables:- AgencyId; integer; The agency identifier of the public sector entity to which this work schedule applies.
- ScheduleId; string; The unique identifier of the work schedule.
- simpleSearchFinder: Finds any work schedules with an ID or description that matches the criteria specified.
Finder Variables:- value; string; The unique identifier or description of the work schedule.
- PrimaryKey: Finds the work schedule that matches the primary key criteria specified.
-
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:- AgencyId; integer; The agency identifier of the public sector entity to which this work schedule applies.
- BetwRecurNum; integer; The number of weeks between occurrences of the schedule. If Recurrence is true, this is a required field.
- BreakTimeFrom; string; The start time for a break within the work schedule.
- BreakTimeTo; string; The end time for a break within the work schedule.
- CreatedBy; string; The user who created the work schedule.
- CreationDate; string; The date and time that the work schedule was created.
- Description; string; The description of the work schedule.
- FriFlag; string; Indicates that the work schedule is active on Friday.
- LastUpdateDate; string; The date and time that the work schedule was last modified.
- LastUpdatedBy; string; The user who last modified the work schedule.
- MonFlag; string; Indicates that the work schedule is active on Monday.
- Recurrence; string; The recurrence indicates whether the schedule repeats on a weekly basis. If true, the schedule repeats every BetwRecurNum weeks. If false, the schedule does not repeat. The default value is true.
- SatFlag; string; Indicates that the work schedule is active on Saturday.
- ScheduleId; string; The unique identifier for the work schedule.
- SunFlag; string; Indicates that the work schedule is active on Sunday.
- ThuFlag; string; Indicates that the work schedule is active on Thursday.
- TueFlag; string; Indicates that the work schedule is active on Tuesday.
- ValidFromDate; string; The start date on which the work schedule becomes effective.
- ValidToDate; string; The end date after which the work schedule is no longer effective.
- WedFlag; string; Indicates that the work schedule is active on Wednesday.
- WorkTimeFrom; string; The work start time for the work schedule.
- WorkTimeTo; string; The work end time for the work schedule.
-
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(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 : publicSectorWorkSchedules
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 : publicSectorWorkSchedules-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency identifier of the public sector entity to which this work schedule applies. -
BetwRecurNum: integer
(int32)
Title:
Weeks Between Occurrences
The number of weeks between occurrences of the schedule. If Recurrence is true, this is a required field. -
BreakTimeFrom: string
(date-time)
Title:
Break Start Time
The start time for a break within the work schedule. -
BreakTimeTo: string
(date-time)
Title:
Break End Time
The end time for a break within the work schedule. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the work schedule. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time that the work schedule was created. -
Description: string
Title:
Description
Maximum Length:100
The description of the work schedule. -
FriFlag: string
Maximum Length:
1
Indicates that the work schedule is active on Friday. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time that the work schedule was last modified. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last modified the work schedule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MonFlag: string
Maximum Length:
1
Indicates that the work schedule is active on Monday. -
Recurrence: string
Title:
Recurrence
Maximum Length:3
The recurrence indicates whether the schedule repeats on a weekly basis. If true, the schedule repeats every BetwRecurNum weeks. If false, the schedule does not repeat. The default value is true. -
SatFlag: string
Maximum Length:
1
Indicates that the work schedule is active on Saturday. -
ScheduleId: string
Title:
Schedule ID
Maximum Length:30
The unique identifier for the work schedule. -
SunFlag: string
Maximum Length:
1
Indicates that the work schedule is active on Sunday. -
ThuFlag: string
Maximum Length:
1
Indicates that the work schedule is active on Thursday. -
TueFlag: string
Maximum Length:
1
Indicates that the work schedule is active on Tuesday. -
ValidFromDate: string
(date)
Title:
Start Date
The start date on which the work schedule becomes effective. -
ValidToDate: string
(date)
Title:
End Date
The end date after which the work schedule is no longer effective. -
WedFlag: string
Maximum Length:
1
Indicates that the work schedule is active on Wednesday. -
WorkTimeFrom: string
(date-time)
Title:
Work Start Time
The work start time for the work schedule. -
WorkTimeRange: string
Title:
Work Time
Maximum Length:80
The time range (start time to end time) for the work schedule. This attribute is read-only and cannot be updated by the resource consumer. -
WorkTimeTo: string
(date-time)
Title:
Work End Time
The work end time for the work schedule.
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.