Update a sales forecast metric definition
patch
/crmRestApi/resources/11.13.18.05/salesForecastMetricDefinitions/{MetricDefnId}
Request
Path Parameters
-
MetricDefnId(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
-
JobRequestId: integer
The submitted process identifier of the sales forecast metric definition.
-
ObjectVersionNumber: integer
(int32)
The object version number of the sales forecast metric definition.
-
StatusCode: string
Maximum Length:
20
The status code of the sales forecast metric definition.
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 : salesForecastMetricDefinitions-item-response
Type:
Show Source
object
-
AdjustableFlag: boolean
Maximum Length:
1
Indicates whether the sales forecast metric such as Best Case or Expected Revenue allows adjustments. The accepted values are Y or N. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the sales forecast metric definition. -
CreationDate: string
(date-time)
Read Only:
true
The date when the sales forecast metric definition was created. -
DepndMetricCodeList: string
Maximum Length:
300
The list of dependent metric codes of the sales forecast metric definition. -
JobRequestId: integer
The submitted process identifier of the sales forecast metric definition.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the sales forecast metric definition was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the sales forecast metric definition. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The last updated login of the sales forecast metric definition. -
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 metric definition. -
MetricDefnId: integer
(int64)
The metric definition identifier of the sales forecast metric definition.
-
MetricName: string
Read Only:
true
The metric name of the sales forecast metric definition. -
MetricSrcCode: string
Maximum Length:
255
The metric source code of the sales forecast metric definition. -
ObjectVersionNumber: integer
(int32)
The object version number of the sales forecast metric definition.
-
StatusCode: string
Maximum Length:
20
The status code of the sales forecast metric definition.
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.