Update an aggregation schedule
patch
/fscmRestApi/resources/11.13.18.05/collaborationAggregationSchedules/{ScheduleId}
Request
Path Parameters
-
ScheduleId(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=
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
-
DisplayedAggregationLevel: string
Title:
Displayed Aggregation Level
Maximum Length:30
Abbreviation that identifies the displayed aggregation level for supply chain collaboration. A list of acceptable values is defined in the lookup type ORA_VCS_AGGREG_LEVEL .
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 : collaborationAggregationSchedules-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the collaboration aggregation schedule. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the collaboration aggregation schedule was created. -
DisplayedAggregationLevel: string
Title:
Displayed Aggregation Level
Maximum Length:30
Abbreviation that identifies the displayed aggregation level for supply chain collaboration. A list of acceptable values is defined in the lookup type ORA_VCS_AGGREG_LEVEL . -
EffectiveFromDate: string
(date)
Title:
Effective from Date
Read Only:true
Date and time from when the collaboration aggregation schedule is effective. -
EffectiveToDate: string
(date)
Title:
Effective to Date
Read Only:true
Date and time from when the collaboration aggregation schedule is no longer effective. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time of the last update of the collaboration aggregation schedule. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the collaboration aggregation schedule.. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Schedule
Read Only:true
Maximum Length:255
Name of the collaboration aggregation schedule. -
QuarterlyTypeCode: string
Title:
Quarterly Type
Read Only:true
Maximum Length:20
Abbreviation that identifies the quarterly type of the aggregation schedule for supply chain collaboration. A list of acceptable values is defined in the lookup type ORA_VCS_BUCKET_AGGR_LEVEL . -
ScheduleId: integer
(int64)
Read Only:
true
Value that uniquely identifies the aggregation schedule for supply chain collaboration. -
SourceScheduleId: integer
(int64)
Read Only:
true
Value that uniquely identifies the source schedule for supply chain collaboration. -
StatusCode: string
Read Only:
true
Maximum Length:30
Default Value:I
Code that identifies the current state of the collaboration aggregation schedule for supply chain collaboration. A list of accepted values is defined in the lookup type ORA_VCS_FORECAST_PROCESS_STATU.
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.