Update one forecasting parameter value for a forecasting profile
patch
/fscmRestApi/resources/11.13.18.05/forecastingProfiles/{ForecastingProfileId}/child/forecastingParameters/{ForecastingParameterId}
Request
Path Parameters
-
ForecastingParameterId(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=
-
ForecastingProfileId(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
-
ForecastingParameterId: integer
(int64)
Value that uniquely identifies the forecasting parameter.
-
ForecastingParameterValue: string
Maximum Length:
20
Value of the forecasting parameter.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : forecastingProfiles-forecastingParameters-item-response
Type:
Show Source
object
-
ForecastingParameterDefaultValue: string
Read Only:
true
Maximum Length:50
Default value of the forecasting parameter. -
ForecastingParameterDescription: string
Read Only:
true
Maximum Length:1000
Description of the forecasting parameter. -
ForecastingParameterId: integer
(int64)
Value that uniquely identifies the forecasting parameter.
-
ForecastingParameterName: string
Read Only:
true
Maximum Length:500
Name of the forecasting parameter. -
ForecastingParameterValue: string
Maximum Length:
20
Value of the forecasting parameter. -
ForecastingProfileId: integer
(int64)
Read Only:
true
Value that uniquely identifies the forecasting profile. -
ForecastingProfileName: string
Read Only:
true
Maximum Length:250
Name of the forecasting profile. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
Examples
This example describes how to update one forecasting parameter value for a forecasting profile.
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/forecastingProfiles/ForecastingProfileId/child/forecastingParameters/ForecastingParameterId"
For example:
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/forecastingProfiles/300100572162014/child/forecastingParameters/300100572162016"
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.
{ "ForecastingParameterValue" : "4.5" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "ForecastingProfileId": 300100572162014, "ForecastingProfileName": "UDP Forecast Bookings", "ForecastingParameterId": 300100572162016, "ForecastingParameterName": "ForecastValidationSensitivity", "ForecastingParameterValue": "4.5", "ForecastingParameterDescription": "Specifies the sensitivity of forecast validation. The smaller the value, the stricter the test. For loose forecast validation use values between 5 and 10.", "ForecastingParameterDefaultValue": "3.5", "links": [. . .] }