Get one schedule
get
/fscmRestApi/resources/11.13.18.05/schedules/{ScheduleId}
Request
Path Parameters
-
ScheduleId(required): integer(int64)
The value that uniquely identifies the schedule. It is a primary key that the application generates when it creates a schedule. 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 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 : schedules-item-response
Type:
Show Source
object
-
CategoryCode: string
Title:
Category
Maximum Length:30
The abbreviation that identifies the category. For example, Pager, UK SSP, or Work. -
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. -
DeletedFlag: boolean
Title:
Active
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then the schedule is active and may be used. If false, then the schedule is not active. The default value is true. -
Description: string
Title:
Description
Maximum Length:2000
The description of the schedule that the user specifies when creating an instance. -
EffectiveFromDate: string
(date)
Title:
Effective from Date
The date when the modeling of working and non-working time using the assigned workday patterns starts. This attribute is required. -
EffectiveToDate: string
(date)
Title:
Effective to Date
The date when the modeling of working and non-working time using the assigned workday patterns stops. This attribute is required. -
FirstDayOfWorkWeek: string
Read Only:
true
The name of the day of the week that identifies the start of a work week. The default is Monday. -
FirstDayOfWorkWeekCode: string
Title:
First Day of Week
Maximum Length:30
Default Value:MONDAY
Specifies the day of the week which identifies the start of a work week. Valid values are SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY and SATURDAY. The default is MONDAY. -
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 schedule that the user specifies when creating an instance. This attribute is required. -
NumberOfAssignments: integer
Default Value:
0
The number of business objects associated with a schedule. A value greater than zero restricts how the schedule can be updated. -
QuarterlyTypeCode: string
Title:
Quarterly Type
Maximum Length:30
The value that defines the model of a quarter for a schedule. For example, 13 periods, 4 Weeks - 4 Weeks - 5 Weeks, 4 Weeks - 5 Weeks - 4 Weeks, 5 Weeks - 4 Weeks - 4 Weeks, or Monthly. -
scheduleExceptionAssociations: array
Schedule Exception Associations
Title:
Schedule Exception Associations
The Schedule Exception Associations resource is used to assign one or more schedule exceptions to the schedule. -
ScheduleId: integer
(int64)
Read Only:
true
The value that uniquely identifies the schedule. It is a primary key that the application generates when it creates a schedule. This attribute is required. -
ScheduleTypeCode: string
Title:
Type
Maximum Length:30
Specifies the type of schedule being created. Valid values are Time, Duration, and Elapsed. This attribute is required. -
scheduleWorkdayPatterns: array
Schedule Workday Patterns
Title:
Schedule Workday Patterns
The Schedule Workday Patterns resource is used to assign one or more workday patterns to the schedule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Schedule Exception Associations
Type:
array
Title:
Schedule Exception Associations
The Schedule Exception Associations resource is used to assign one or more schedule exceptions to the schedule.
Show Source
Nested Schema : Schedule Workday Patterns
Type:
array
Title:
Schedule Workday Patterns
The Schedule Workday Patterns resource is used to assign one or more workday patterns to the schedule.
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.
Nested Schema : schedules-scheduleExceptionAssociations-item-response
Type:
Show Source
object
-
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. -
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. -
ScheduleExceptionAssociationId: integer
(int64)
Read Only:
true
The value that uniquely identifies the schedule exception assignment to the parent schedule. It is a primary key that the application generates when a schedule exception is assigned to a schedule. This attribute is required. -
ScheduleExceptionId: integer
(int64)
Title:
Exception Name
The value that uniquely identifies the foreign key reference to the schedule exception being assigned. This attribute is a required input. -
ScheduleExceptionName: string
The name of the assigned schedule exception.
-
ScheduleId: integer
(int64)
The value that uniquely identifies the foreign key reference to the parent schedule. This attribute is a required input.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : schedules-scheduleWorkdayPatterns-item-response
Type:
Show Source
object
-
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. -
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. -
PatternId: integer
(int64)
Title:
Workday Pattern
The value that uniquely identifies the foreign key reference to the associated pattern within the schedule. This attribute is a required input. -
PatternName: string
The name of the associated pattern.
-
PatternSequenceNumber: integer
(int64)
Title:
Sequence
The number that identifies the sequence order of each pattern assigned to a schedule. -
SchedulePatternId: integer
(int64)
Read Only:
true
The value that uniquely identifies the pattern assignment to the parent schedule. It is a primary key that the application generates when a pattern is assigned to a schedule. This attribute is required.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- scheduleExceptionAssociations
-
Operation: /fscmRestApi/resources/11.13.18.05/schedules/{ScheduleId}/child/scheduleExceptionAssociationsParameters:
- ScheduleId:
$request.path.ScheduleId
The Schedule Exception Associations resource is used to assign one or more schedule exceptions to the schedule. - ScheduleId:
- scheduleWorkdayPatterns
-
Parameters:
- ScheduleId:
$request.path.ScheduleId
The Schedule Workday Patterns resource is used to assign one or more workday patterns to the schedule. - ScheduleId:
Examples
This example describes how to get one schedule.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/schedules?finder=PrimaryKey;ScheduleId=ScheduleId"
For example, the following command gets a schedule where the schedule identifier is 100000015760389:
curl -u username:password "https://servername/fscmRestApi/resources/version/schedules?finder=PrimaryKey;ScheduleId=999990012726001"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items" : [ { "ScheduleId" : 100000015760389, "ScheduleTypeCode" : "TIME", "Name" : "BI_ABS_WS_2", "Description" : null, "EffectiveFromDate" : "2004-01-05", "EffectiveToDate" : "2010-01-22", "CategoryCode" : null, "DeletedFlag" : false, "QuarterlyTypeCode" : null, "NumberOfAssignments" : 0, ... } ], ... }