1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Forecasts
  4. Forecast Products

Update a forecast product

patch

/crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/forecastProducts/{FcstProductId}

Request

Path Parameters
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
Nested Schema : Product Adjustment Periods
Type: array
Title: Product Adjustment Periods
The forecast product adjustment periods resource is used to view and update the time period adjustment applied to a forecast product.
Show Source
Nested Schema : territoryForecasts-forecastProducts-forecastProductAdjustmentPeriods-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 : territoryForecasts-forecastProducts-item-response
Type: object
Show Source
Nested Schema : Product Adjustment Periods
Type: array
Title: Product Adjustment Periods
The forecast product adjustment periods resource is used to view and update the time period adjustment applied to a forecast product.
Show Source
Nested Schema : territoryForecasts-forecastProducts-forecastProductAdjustmentPeriods-item-response
Type: object
Show Source
Links
forecastProductAdjustmentPeriods
Parameters:
  • FcstProductId: $request.path.FcstProductId
  • ForecastParticipantId: $request.path.ForecastParticipantId
The forecast product adjustment periods resource is used to view and update the time period adjustment applied to a forecast product.
Back to Top

Examples

The following example shows how to update a forecast product by submitting a patch request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territoryForecasts/7414679/child/forecastProducts/838927

Example of Request Body

The following shows an example of the request body in JSON format.

{
"BestCaseAdjustedForecast": 1000, 
"WorstCaseAdjustedForecast": 100
}

Example of Response Body

The following shows an example of the response body in JSON format.

{
"EntityType": "UNSPECIFIED"
"FcstProductId": 838927
"ParentFcstProductId": 838922
"ProdHierarchyLevel": 2
"SnapshotVersionId": -1
"UnspecifiedFlag": true
"FcstHeaderId": 300100093651293
"AdjustedForecast": 1250000
"Name": " "
"BestCaseAdjustedForecast": 1000
"WorstCaseAdjustedForecast": 100
"UnadjustedForecast": 1250000
"UnadjustedBcAmount": 1250000
...
}
Back to Top