Create a sales forecast quota
post
/crmRestApi/resources/11.13.18.05/salesForecastQuotas
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Comments: string
Maximum Length:
1000
Comments to describe the sales forecast quota. -
ConflictId: integer
(int64)
The conflict ID for the sales forecast quota.
-
CorporateMetricValue: number
The corporate metric value for the sales forecast quota.
-
CurrencyCode: string
Maximum Length:
3
The currency code entered for the sales forecast quota. -
CurrencyConversionRate: number
The currency conversion rate from entered currency to corporate currency for the sales forecast quota.
-
DsQuotaId: integer
(int64)
Title:
Quota ID
The quota ID for the sales forecast quota. -
MetricCode: string
Title:
Target Type
Maximum Length:100
The metric code for the sales forecast quota. -
MetricDimensionFiveKey: string
Title:
Dimension 5
Maximum Length:300
The metric key for the fifth dimension of sales forecast quota. -
MetricDimensionFourKey: string
Title:
Dimension 4
Maximum Length:300
The metric key for the fourth dimension of sales forecast quota. -
MetricDimensionOneKey: string
Title:
Dimension 1
Maximum Length:300
The metric key for the first dimension of sales forecast quota. -
MetricDimensionThreeKey: string
Title:
Dimension 3
Maximum Length:300
The metric key for the third dimension of sales forecast quota. -
MetricDimensionTwoKey: string
Title:
Dimension 2
Maximum Length:300
The metric key for the second dimension of sales forecast quota. -
MetricValue: number
The metric value in the entered currency for the sales forecast quota.
-
ObjectVersionNumber: integer
(int32)
The object version number for the sales forecast quota.
-
QuotaNumber: string
Maximum Length:
30
The quota number for the sales forecast quota. -
ResourceQuotaEffectiveDate: string
(date)
Title:
Effective Date
The resource quota effective date used to identify the period for the sales forecast quota.
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 : salesForecastQuotas-item-response
Type:
Show Source
object
-
Comments: string
Maximum Length:
1000
Comments to describe the sales forecast quota. -
ConflictId: integer
(int64)
The conflict ID for the sales forecast quota.
-
CorporateMetricValue: number
The corporate metric value for the sales forecast quota.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the sales forecast quota. -
CreationDate: string
(date-time)
Read Only:
true
The date when the sales forecast quota was created. -
CurrencyCode: string
Maximum Length:
3
The currency code entered for the sales forecast quota. -
CurrencyConversionRate: number
The currency conversion rate from entered currency to corporate currency for the sales forecast quota.
-
DsQuotaId: integer
(int64)
Title:
Quota ID
The quota ID for the sales forecast quota. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the sales forecast quota was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the sales forecast quota. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the sales forecast quota. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MetricCode: string
Title:
Target Type
Maximum Length:100
The metric code for the sales forecast quota. -
MetricDimensionFiveKey: string
Title:
Dimension 5
Maximum Length:300
The metric key for the fifth dimension of sales forecast quota. -
MetricDimensionFourKey: string
Title:
Dimension 4
Maximum Length:300
The metric key for the fourth dimension of sales forecast quota. -
MetricDimensionOneKey: string
Title:
Dimension 1
Maximum Length:300
The metric key for the first dimension of sales forecast quota. -
MetricDimensionThreeKey: string
Title:
Dimension 3
Maximum Length:300
The metric key for the third dimension of sales forecast quota. -
MetricDimensionTwoKey: string
Title:
Dimension 2
Maximum Length:300
The metric key for the second dimension of sales forecast quota. -
MetricDimFiveCode: string
Read Only:
true
Maximum Length:100
The metric code for the fifth dimension of sales forecast quota. -
MetricDimFourCode: string
Read Only:
true
Maximum Length:100
The metric code for the fourth dimension of sales forecast quota. -
MetricDimOneCode: string
Read Only:
true
Maximum Length:100
The metric code for the first dimension of sales forecast quota. -
MetricDimThreeCode: string
Read Only:
true
Maximum Length:100
The metric code for the third dimension of sales forecast quota. -
MetricDimTwoCode: string
Read Only:
true
Maximum Length:100
The metric code for the second dimension of sales forecast quota. -
MetricSrcCode: string
Read Only:
true
Maximum Length:100
The metric source code for the sales forecast quota. -
MetricValue: number
The metric value in the entered currency for the sales forecast quota.
-
ObjectVersionNumber: integer
(int32)
The object version number for the sales forecast quota.
-
QuotaNumber: string
Maximum Length:
30
The quota number for the sales forecast quota. -
ResourceQuotaEffectiveDate: string
(date)
Title:
Effective Date
The resource quota effective date used to identify the period for the sales forecast quota.
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.