Update a work schedule
patch
/fscmRestApi/resources/11.13.18.05/publicSectorWorkSchedules/{publicSectorWorkSchedulesUniqID}
Request
Path Parameters
-
publicSectorWorkSchedulesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- ScheduleId and AgencyId ---for the Work Schedules resource and used to uniquely identify an instance of Work Schedules. The client should not generate the hash key value. Instead, the client should query on the Work Schedules collection resource with a filter on the primary key values in order to navigate to a specific instance of Work Schedules.
For example: publicSectorWorkSchedules?q=ScheduleId=<value1>;AgencyId=<value2>
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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. -
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. -
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. -
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.
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.
Root 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.