Update a calendar
patch
/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/calendars/{calendarsUniqID}
Request
Path Parameters
-
PlanId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
calendarsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- PlanId and CalendarId ---for the Calendars resource and used to uniquely identify an instance of Calendars. The client should not generate the hash key value. Instead, the client should query on the Calendars collection resource with a filter on the primary key values in order to navigate to a specific instance of Calendars.
For example: calendars?q=PlanId=<value1>;CalendarId=<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
-
CalendarCode(required): string
Maximum Length:
300
Abbreviation that identifies the calendar. -
calendarEvents: array
Calendar Events
Title:
Calendar Events
The Calendar Events resource manages the specific events on a calendar that indicates what time a resource is available. -
CalendarId(required): integer
(int64)
Value that uniquely identifies the calendar.
-
Description: string
Maximum Length:
2000
Description of the calendar. -
PlanId(required): integer
(int64)
Value that uniquely identifies the production schedule.
Nested Schema : Calendar Events
Type:
array
Title:
Calendar Events
The Calendar Events resource manages the specific events on a calendar that indicates what time a resource is available.
Show Source
Nested Schema : productionSchedulingPlans-calendars-calendarEvents-item-patch-request
Type:
Show Source
object
-
CalendarId: integer
(int64)
Value that uniquely identifies the calendar.
-
EndDate: string
(date-time)
Date and time when the calendar event is no longer effective.
-
EventType: string
Maximum Length:
20
Type of calendar event. Valid values are Delay or Down. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
StartDate: string
(date-time)
Date and time when the calendar event is effective.
Response
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 : productionSchedulingPlans-calendars-item-response
Type:
Show Source
object
-
CalendarCode: string
Maximum Length:
300
Abbreviation that identifies the calendar. -
calendarEvents: array
Calendar Events
Title:
Calendar Events
The Calendar Events resource manages the specific events on a calendar that indicates what time a resource is available. -
CalendarId: integer
(int64)
Value that uniquely identifies the calendar.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
Description: string
Maximum Length:
2000
Description of the calendar. -
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
Nested Schema : Calendar Events
Type:
array
Title:
Calendar Events
The Calendar Events resource manages the specific events on a calendar that indicates what time a resource is available.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-calendars-calendarEvents-item-response
Type:
Show Source
object
-
CalendarId: integer
(int64)
Value that uniquely identifies the calendar.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
EndDate: string
(date-time)
Date and time when the calendar event is no longer effective.
-
EventType: string
Maximum Length:
20
Type of calendar event. Valid values are Delay or Down. -
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
StartDate: string
(date-time)
Date and time when the calendar event is effective.
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.
Links
- applyCalendarPattern
-
Parameters:
- PlanId:
$request.path.PlanId
- calendarsUniqID:
$request.path.calendarsUniqID
Request changing a single calendar event to run scenarios with changing downtime or availability to assess the impact to the schedule. - PlanId:
- calendarEvents
-
Parameters:
- PlanId:
$request.path.PlanId
- calendarsUniqID:
$request.path.calendarsUniqID
The Calendar Events resource manages the specific events on a calendar that indicates what time a resource is available. - PlanId: