Get a period adjustment for a forecast product
get
/crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/forecastProducts/{FcstProductId}/child/forecastProductAdjustmentPeriods/{FcstAdjustPeriodId}
Request
Path Parameters
-
FcstAdjustPeriodId(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=
-
FcstProductId(required): integer(int64)
The unique identifier of the product.
-
ForecastParticipantId(required): integer(int64)
The unique identifier of the participant associated with the territory forecast.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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-forecastProducts-forecastProductAdjustmentPeriods-item-response
Type:
Show Source
object
-
AdjustedForecast: number
The value of the forecast product after adjustments.
-
AdjustedQuantity: number
The value of the adjusted quantity.
-
AdjustmentPeriodEndDate: string
(date)
Read Only:
true
The date when the forecast ends. -
AdjustmentPeriodStartDate: string
(date)
Read Only:
true
The date when the forecast starts. -
BestCaseAdjustedForecast: number
The best case value of the forecast after adjustments.
-
BestCaseUnadjustedForecast: number
Read Only:
true
The best case value of the unadjusted product forecast. -
FcstAdjustPeriodId: integer
(int64)
Read Only:
true
The unique identifier of the summary level forecast adjustment. -
FcstHeaderId: integer
(int64)
Title:
Forecast Type
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. -
FcstProductId: integer
(int64)
Read Only:
true
The unique identifier of the product that the forecast item is associated with. -
InventoryItemId: integer
(int64)
Read Only:
true
The unique identifier of the inventory item that is generated during product creation. This attribute in combination with the InvOrgID attribute forms the composite unique identifier of the inventory item. -
InvOrgId: integer
(int64)
Read Only:
true
The unique identifier of the inventory organization that is generated during product creation. This attribute in combination with the InventoryItemID attribute forms the composite unique identifier of the inventory item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NewAdjustedForecast: number
The net new value of the product forecast after adjustments.
-
NewAdjustedQuantity: number
The value of the adjusted quantity for net new.
-
NewBestCaseAdjustedForecast: number
The net new best case value of the forecast after adjustments.
-
NewBestCaseUnadjustedForecast: number
Read Only:
true
The net new best case value of the unadjusted product forecast. -
NewUnadjustedForecast: number
Read Only:
true
The value of the unadjusted territory forecast for net new. -
NewUnadjustedQuantity: number
Read Only:
true
The value of the unadjusted quantity for net new. -
NewWorstCaseAdjustedForecast: number
The net new worst case value of the forecast after adjustments.
-
NewWorstCaseUnadjustedForecast: number
Read Only:
true
The net new worst case value of the unadjusted product forecast. -
ParentFcstProductId: integer
(int64)
Read Only:
true
The unique identifier of the parent product. -
PeriodName: string
Title:
Adjustment Period
Read Only:true
Maximum Length:15
The name of the forecast period. -
PeriodSetName: string
Read Only:
true
Maximum Length:15
The name of the adjustment period. -
ProductGroupId: integer
(int64)
Read Only:
true
The unique identifier of the product group. -
RenewalAdjustedForecast: number
The renewal value of the product forecast after adjustments.
-
RenewalAdjustedQuantity: number
The value of the adjusted quantity for renewals.
-
RenewalBestCaseAdjustedForecast: number
The renewal best case value of the forecast after adjustments.
-
RenewalBestCaseUnadjustedForecast: number
Read Only:
true
The renewal best case value of the unadjusted product forecast. -
RenewalUnadjustedForecast: number
Read Only:
true
The value of the unadjusted territory forecast for renewals. -
RenewalUnadjustedQuantity: number
Read Only:
true
The value of the unadjusted quantity for renewals. -
RenewalWorstCaseAdjustedForecast: number
The renewal worst case value of the forecast after adjustments.
-
RenewalWorstCaseUnadjustedForecast: number
Read Only:
true
The renewal worst case value of the unadjusted product forecast. -
TerritoryId: integer
(int64)
Title:
Territory ID
Read Only:true
The unique identifier of the territory. -
UnadjustedForecast: number
Read Only:
true
The value of the unadjusted product forecast. -
UnadjustedQuantity: number
Read Only:
true
The value of the unadjusted quantity. -
UpdateFlag: boolean
Read Only:
true
Indicates if the user has access to update the record. -
WorstCaseAdjustedForecast: number
The worst case value of the unadjusted product forecast after adjustments.
-
WorstCaseUnadjustedForecast: number
Read Only:
true
The worst case value of the unadjusted product forecast.
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.