Update a period adjustment for a forecast
patch
/crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/forecastAdjustmentPeriods/{FcstAdjustPeriodId}
Request
Path Parameters
-
FcstAdjustPeriodId(required): integer(int64)
The unique identifier of the forecast adjustment period.
-
ForecastParticipantId(required): integer(int64)
The unique identifier of the participant associated with the territory forecast.
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
-
AdjustedForecast: number
The value of the revenue for the territory after adjustments.
-
NewAdjustedForecast: number
The net new forecast value of the territory after adjustments.
-
NewUnadjustedForecast: number
The value of the unadjusted territory forecast for net new.
-
PeriodName: string
Title:
Adjustment Period
Maximum Length:15
The name of the forecast adjustment period. -
RenewalAdjustedForecast: number
The renewal forecast value of the territory after adjustments.
-
RenewalUnadjustedForecast: number
The value of the unadjusted territory forecast for renewals.
-
UnadjustedForecast: number
The value of the unadjusted territory forecast.
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 : territoryForecasts-forecastAdjustmentPeriods-item-response
Type:
Show Source
object
-
AdjustedForecast: number
The value of the revenue for the territory after adjustments.
-
AdjustmentComment: string
Read Only:
true
Maximum Length:360
The additional comments entered while making the adjustment. -
AdjustmentReason: string
Read Only:
true
Maximum Length:360
The code indicating the reason for adjusting the forecast. -
FcstAdjustmentId: integer
(int64)
Read Only:
true
The unique identifier of the adjustment made to the territory forecast. -
FcstAdjustPeriodId: integer
(int64)
Read Only:
true
The unique identifier of the forecast adjustment period. -
FcstHeaderId: integer
(int64)
Title:
Forecast Header ID
Read Only:true
The unique identifier of the forecast. -
FcstParticipantId: integer
(int64)
Title:
Participant ID
Read Only:true
The unique identifier of the territory forecast participant. -
LastAdjustedDate: string
(date)
Read Only:
true
The date when the territory forecast was last adjusted. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NewAdjustedForecast: number
The net new forecast value of the territory after adjustments.
-
NewUnadjustedForecast: number
The value of the unadjusted territory forecast for net new.
-
PeriodName: string
Title:
Adjustment Period
Maximum Length:15
The name of the forecast adjustment period. -
RenewalAdjustedForecast: number
The renewal forecast value of the territory after adjustments.
-
RenewalUnadjustedForecast: number
The value of the unadjusted territory forecast for renewals.
-
TerritoryId: integer
(int64)
Title:
Territory ID
Read Only:true
The unique identifier of the territory. -
UnadjustedForecast: number
The value of the unadjusted territory forecast.
-
UpdateFlag: boolean
Read Only:
true
Indicates if the user has access to update the record.
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.