1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. SCM Common
  4. Schedules

Get all schedules

get

/fscmRestApi/resources/11.13.18.05/schedules

Request

Query Parameters
  • 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).
  • 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
  • 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: Find a schedule according to the unique schedule identification.
      Finder Variables:
      • ScheduleId; integer; Value that uniquely identifies the schedule. It is a primary key that the application generates when it creates a schedule. This attribute is required.
    • ScheduleTypeCodeFinder: Find schedules according to the type of schedule.
      Finder Variables:
      • ScheduleTypeCode; string; Value that specifies the type of schedule being created. Valid values are Time, Duration, and Elapsed. This attribute is required.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • CategoryCode; string; The abbreviation that identifies the category. For example, Pager, UK SSP, or Work.
    • CreatedBy; string; User who created the record.
    • CreationDate; string; Date and time when the user created the record.
    • DeletedFlag; boolean; 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; The description of the schedule that the user specifies when creating an instance.
    • EffectiveFromDate; string; The date when the modeling of working and non-working time using the assigned workday patterns starts. This attribute is required.
    • EffectiveToDate; string; The date when the modeling of working and non-working time using the assigned workday patterns stops. This attribute is required.
    • FirstDayOfWorkWeek; string; The name of the day of the week that identifies the start of a work week. The default is Monday.
    • FirstDayOfWorkWeekCode; string; 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 and time when the user most recently updated the record.
    • LastUpdatedBy; string; User who most recently updated the record.
    • Name; string; The name of the schedule that the user specifies when creating an instance. This attribute is required.
    • NumberOfAssignments; integer; The number of business objects associated with a schedule. A value greater than zero restricts how the schedule can be updated.
    • QuarterlyTypeCode; string; 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.
    • ScheduleId; integer; 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; Specifies the type of schedule being created. Valid values are Time, Duration, and Elapsed. This attribute is required.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : schedules
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : schedules-item-response
Type: object
Show Source
  • Title: Category
    Maximum Length: 30
    The abbreviation that identifies the category. For example, Pager, UK SSP, or Work.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the record.
  • Title: Creation Date
    Read Only: true
    Date and time when the user created the record.
  • 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.
  • Title: Description
    Maximum Length: 2000
    The description of the schedule that the user specifies when creating an instance.
  • 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.
  • 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.
  • Read Only: true
    The name of the day of the week that identifies the start of a work week. The default is Monday.
  • 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.
  • Title: Last Updated Date
    Read Only: true
    Date and time when the user most recently updated the record.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • Title: Name
    Maximum Length: 240
    The name of the schedule that the user specifies when creating an instance. This attribute is required.
  • Default Value: 0
    The number of business objects associated with a schedule. A value greater than zero restricts how the schedule can be updated.
  • 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.
  • Schedule Exception Associations
    Title: Schedule Exception Associations
    The Schedule Exception Associations resource is used to assign one or more schedule exceptions to the schedule.
  • 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.
  • Title: Type
    Maximum Length: 30
    Specifies the type of schedule being created. Valid values are Time, Duration, and Elapsed. This attribute is required.
  • 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 : 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 : schedules-scheduleExceptionAssociations-item-response
Type: object
Show Source
Nested Schema : schedules-scheduleWorkdayPatterns-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all schedules.

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"

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,
...
  }, {
...
  } ],
...
}
Back to Top