Update a sales forecast adjustment
patch
/crmRestApi/resources/11.13.18.05/salesForecastAdjustments/{AdjustmentId}
Request
Path Parameters
-
AdjustmentId(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
-
AdjustedMetricValue: number
The adjusted metric value for the sales forecast adjustment.
-
MetricCode: string
Maximum Length:
100
The metric code of the sales forecast adjustment. -
MetricDim2Key: integer
(int64)
The metric key for the second dimension of sales forecast adjustment.
-
MetricDim3Key: integer
(int64)
The metric key for the third dimension of sales forecast adjustment.
-
MetricDim4Key: integer
(int64)
The metric key for the fourth dimension of sales forecast adjustment.
-
MetricDim5Key: integer
(int64)
The metric key for the fifth dimension of sales forecast adjustment.
-
MetricSrcOvn1: integer
(int32)
The object version number for the first metric source.
-
MetricSrcOvn2: integer
(int32)
The object version number for the second metric source.
-
MetricSrcOvn3: integer
(int32)
The object version number for the third sales metric source.
-
MetricSrcPk1: integer
(int64)
The first unique identifier of the sales forecast source item.
-
MetricSrcPk2: integer
(int64)
The second unique identifier of the sales forecast source item.
-
MetricSrcPk3: integer
(int64)
The third unique identifier of the sales forecast source item.
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 : salesForecastAdjustments-item-response
Type:
Show Source
object
-
AdjustedByMetricDim1Key: integer
(int64)
Indicates the first dimension metric key for the user who performs the sales forecast adjustment.
-
AdjustedMetricValue: number
The adjusted metric value for the sales forecast adjustment.
-
AdjustmentId: integer
(int64)
The adjustment ID for the sales forecast adjustment.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the sales forecast adjustment. -
CreationDate: string
(date-time)
Read Only:
true
The date when the sales forecast adjustment was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the sales forecast adjustment was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the sales forecast adjustment. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the sales forecast adjustment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MetricCode: string
Maximum Length:
100
The metric code of the sales forecast adjustment. -
MetricDim1Key: integer
(int64)
The metric key for the first dimension of sales forecast adjustment.
-
MetricDim2Key: integer
(int64)
The metric key for the second dimension of sales forecast adjustment.
-
MetricDim3Key: integer
(int64)
The metric key for the third dimension of sales forecast adjustment.
-
MetricDim4Key: integer
(int64)
The metric key for the fourth dimension of sales forecast adjustment.
-
MetricDim5Key: integer
(int64)
The metric key for the fifth dimension of sales forecast adjustment.
-
MetricSrcOvn1: integer
(int32)
The object version number for the first metric source.
-
MetricSrcOvn2: integer
(int32)
The object version number for the second metric source.
-
MetricSrcOvn3: integer
(int32)
The object version number for the third sales metric source.
-
MetricSrcPk1: integer
(int64)
The first unique identifier of the sales forecast source item.
-
MetricSrcPk2: integer
(int64)
The second unique identifier of the sales forecast source item.
-
MetricSrcPk3: integer
(int64)
The third unique identifier of the sales forecast source item.
-
ObjectVersionNumber: integer
(int32)
Read Only:
true
The object version number for the sales forecast adjustment. -
PeriodId: integer
(int64)
The period identifier for the sales forecast adjustment.
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.