Get a work schedule
get
/fscmRestApi/resources/11.13.18.05/publicSectorWorkSchedules/{publicSectorWorkSchedulesUniqID}
Request
Path Parameters
-
publicSectorWorkSchedulesUniqID: integer
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>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorWorkSchedules-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency identifier of the public sector entity to which this work schedule applies. -
BetwRecurNum(optional):
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(optional):
string(date-time)
Title:
Break Start Time
The start time for a break within the work schedule. -
BreakTimeTo(optional):
string(date-time)
Title:
Break End Time
The end time for a break within the work schedule. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the work schedule. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the work schedule was created. -
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the work schedule. -
FriFlag(optional):
string
Maximum Length:
1
Indicates that the work schedule is active on Friday. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time that the work schedule was last modified. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last modified the work schedule. -
links(optional):
array Items
Title:
Items
Link Relations -
MonFlag(optional):
string
Maximum Length:
1
Indicates that the work schedule is active on Monday. -
Recurrence(optional):
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(optional):
string
Maximum Length:
1
Indicates that the work schedule is active on Saturday. -
ScheduleId(optional):
string
Title:
Schedule ID
Maximum Length:30
The unique identifier for the work schedule. -
SunFlag(optional):
string
Maximum Length:
1
Indicates that the work schedule is active on Sunday. -
ThuFlag(optional):
string
Maximum Length:
1
Indicates that the work schedule is active on Thursday. -
TueFlag(optional):
string
Maximum Length:
1
Indicates that the work schedule is active on Tuesday. -
ValidFromDate(optional):
string(date)
Title:
Start Date
The start date on which the work schedule becomes effective. -
ValidToDate(optional):
string(date)
Title:
End Date
The end date after which the work schedule is no longer effective. -
WedFlag(optional):
string
Maximum Length:
1
Indicates that the work schedule is active on Wednesday. -
WorkTimeFrom(optional):
string(date-time)
Title:
Work Start Time
The work start time for the work schedule. -
WorkTimeRange(optional):
string
Title:
Work Time
Maximum Length:255
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(optional):
string(date-time)
Title:
Work End Time
The work end time for the work schedule.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.