1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. SCM Common
  4. Schedules

Update one schedule

patch

/fscmRestApi/resources/11.13.18.05/schedules/{ScheduleId}

Request

Path Parameters
  • 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.
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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Category
    Maximum Length: 30
    The abbreviation that identifies the category. For example, Pager, UK SSP, or Work.
  • 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.
  • 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: Name
    Maximum Length: 240
    The name of the schedule that the user specifies when creating an instance. This attribute is required.
  • 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.
  • 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-patch-request
Type: object
Show Source
Nested Schema : schedules-scheduleWorkdayPatterns-item-patch-request
Type: object
Show Source
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-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
Links
scheduleExceptionAssociations
Parameters:
  • ScheduleId: $request.path.ScheduleId
The Schedule Exception Associations resource is used to assign one or more schedule exceptions to the schedule.
scheduleWorkdayPatterns
Parameters:
  • ScheduleId: $request.path.ScheduleId
The Schedule Workday Patterns resource is used to assign one or more workday patterns to the schedule.
Back to Top

Examples

This example describes how to update one schedule.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/schedules/ScheduleId"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates. 

{
	"Name" : "Schedule-Example", 
	"EffectiveToDate" : "2022-12-31", 
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{ 
	"ScheduleId" : 300100126667088, 
	"ScheduleTypeCode" : "TIME", 
	"Name" : "Schedule-Example", 
	"Description" : "Schedule Example of Post", 
	"EffectiveFromDate" : "2018-01-01", 
	"EffectiveToDate" : "2021-12-31", 
	"CategoryCode" : "WORK", 
	"DeletedFlag" : false, 
	"QuarterlyTypeCode" : "13_PERIODS", 
	"NumberOfAssignments" : 0, 
	"scheduleWorkdayPatterns" : [ { 
		"SchedulePatternId" : 300100126667089, 
		"PatternSequenceNumber" : 1, 
		"PatternId" : 999990012726001, 
		"PatternName" : "6 day working 9-5 Time", 
		"links" : [ {
			...
		}]
	}]
	...
}
Back to Top