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

Update a territory forecast

patch

/crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}

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 : Adjustment Periods
Type: array
Title: Adjustment Periods
The forecast adjustment periods resource is used to view and update the time period adjustment applied to a territory forecast.
Show Source
Nested Schema : Forecast Items
Type: array
Title: Forecast Items
The forecast items resource is used view and update the items associated with a forecast.
Show Source
Nested Schema : Forecast Products
Type: array
Title: Forecast Products
The forecast products resource is used to view and update the products associated with a forecast. The forecast products resource displays forecasts categorized by product.
Show Source
Nested Schema : Revenue Items
Type: array
Title: Revenue Items
The revenue items resource is used to view the revenue items that are not included in the forecast associated with a territory.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested 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
Nested Schema : territoryForecasts-unforecastedPipeline-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-item-response
Type: object
Show Source
Nested Schema : Adjustment Periods
Type: array
Title: Adjustment Periods
The forecast adjustment periods resource is used to view and update the time period adjustment applied to a territory forecast.
Show Source
Nested Schema : Forecast Items
Type: array
Title: Forecast Items
The forecast items resource is used view and update the items associated with a forecast.
Show Source
Nested Schema : Forecast Products
Type: array
Title: Forecast Products
The forecast products resource is used to view and update the products associated with a forecast. The forecast products resource displays forecasts categorized by product.
Show Source
Nested Schema : Revenue Items
Type: array
Title: Revenue Items
The revenue items resource is used to view the revenue items that are not included in the forecast associated with a territory.
Show Source
Nested Schema : territoryForecasts-forecastAdjustmentPeriods-item-response
Type: object
Show Source
Nested Schema : territoryForecasts-ForecastItemDetail-item-response
Type: object
Show Source
Nested 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
Nested Schema : territoryForecasts-unforecastedPipeline-item-response
Type: object
Show Source
Links
ForecastItemDetail
Parameters:
  • ForecastParticipantId: $request.path.ForecastParticipantId
The forecast items resource is used view and update the items associated with a forecast.
ForecastTypeLookup
Parameters:
  • finder: LookupTypeFinder%3BBindLookupType%3DZSF_FCST_TYPE
The list of values for the type of the forecast, such as Revenue or Overlay.

The following properties are defined on the LOV link relation:
  • Source Attribute: ForecastType; Target Attribute: LookupCode
  • Display Attribute: Meaning
LookupPVO
Parameters:
  • finder: LookupTypeFinder%3BBindLookupType%3DZSF_FCST_STATUS
The list of values for the status of the forecast, such as Submitted or Unsubmitted.

The following properties are defined on the LOV link relation:
  • Source Attribute: StatusCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
forecastAdjustmentPeriods
Parameters:
  • ForecastParticipantId: $request.path.ForecastParticipantId
The forecast adjustment periods resource is used to view and update the time period adjustment applied to a territory forecast.
forecastProducts
Parameters:
  • ForecastParticipantId: $request.path.ForecastParticipantId
The forecast products resource is used to view and update the products associated with a forecast. The forecast products resource displays forecasts categorized by product.
unforecastedPipeline
Parameters:
  • ForecastParticipantId: $request.path.ForecastParticipantId
The revenue items resource is used to view the revenue items that are not included in the forecast associated with a territory.
Back to Top

Examples

The following example shows how to update a territory forecast 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

Example of Request Body

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

{
"StatusCode": "SUBMITTED"
}

Example of Response Body

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

{
"ForecastParticipantId": 7414679
"ForecastHeaderId": 300100093651293
"StatusCode": "SUBMITTED"
"DueDate": "2016-03-17"
"StartDate": "2016-04-01"
"ForecastName": "Q2-2016 - 2016/03/17"
"TerritoryHierarchyFreezeDate": "2016-02-25"
"Meaning": "Submitted"
"TerritoryLevel": 5
"TerritoryId": 300100012891886
"TerritoryVersionId": 300100026843435
"TerritoryName": "ZSF_Territory_USWest1"
"OwnerResourceId": 300100027483620
"SubmittedBy": "ZSF Sales_Rep3"
"SubmittedOn": "2016-02-25T23:09:45-08:00"
"ForecastType": "REVENUE"
"AdjustedBestCase": 1250000
"AdjustedWorstCase": 0
"ForecastParticipationCode": "REVENUE_AND_NONREVENUE"
"AdjustedForecast": 1250000
"ParentTerritoryOwnerResourceId": 300100027478734
...
}
Back to Top