Jump to

• Request
• Response

Update a sales forecast quota

patch

/crmRestApi/resources/11.13.18.05/salesForecastQuotas/{QuotaNumber}

Request

Path Parameters

• QuotaNumber(required): string
  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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.
• ResourceQuotaEffectiveDate: string (date)
  Title: Effective Date

  The resource quota effective date used to identify the period for the sales forecast quota.

{
    "type":"object",
    "properties":{
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "description":"Comments to describe the sales forecast quota.",
            "nullable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The conflict ID for the sales forecast quota.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CorporateMetricValue":{
            "type":"number",
            "description":"The corporate metric value for the sales forecast quota.",
            "nullable":true
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code entered for the sales forecast quota.",
            "nullable":true
        },
        "CurrencyConversionRate":{
            "type":"number",
            "description":"The currency conversion rate from entered currency to corporate currency for the sales forecast quota.",
            "nullable":true
        },
        "MetricCode":{
            "title":"Target Type",
            "maxLength":100,
            "type":"string",
            "description":"The metric code for the sales forecast quota.",
            "nullable":true
        },
        "MetricDimensionFiveKey":{
            "title":"Dimension 5",
            "maxLength":300,
            "type":"string",
            "description":"The metric key for the fifth dimension of sales forecast quota.",
            "nullable":true
        },
        "MetricDimensionFourKey":{
            "title":"Dimension 4",
            "maxLength":300,
            "type":"string",
            "description":"The metric key for the fourth dimension of sales forecast quota.",
            "nullable":true
        },
        "MetricDimensionOneKey":{
            "title":"Dimension 1",
            "maxLength":300,
            "type":"string",
            "description":"The metric key for the first dimension of sales forecast quota.",
            "nullable":false
        },
        "MetricDimensionThreeKey":{
            "title":"Dimension 3",
            "maxLength":300,
            "type":"string",
            "description":"The metric key for the third dimension of sales forecast quota.",
            "nullable":true
        },
        "MetricDimensionTwoKey":{
            "title":"Dimension 2",
            "maxLength":300,
            "type":"string",
            "description":"The metric key for the second dimension of sales forecast quota.",
            "nullable":true
        },
        "MetricValue":{
            "type":"number",
            "description":"The metric value in the entered currency for the sales forecast quota.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the sales forecast quota.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "ResourceQuotaEffectiveDate":{
            "title":"Effective Date",
            "type":"string",
            "description":"The resource quota effective date used to identify the period for the sales forecast quota.",
            "format":"date",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : salesForecastQuotas-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "description":"Comments to describe the sales forecast quota.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The conflict ID for the sales forecast quota.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CorporateMetricValue":{
            "type":"number",
            "description":"The corporate metric value for the sales forecast quota.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the sales forecast quota.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the sales forecast quota was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code entered for the sales forecast quota.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyConversionRate":{
            "type":"number",
            "description":"The currency conversion rate from entered currency to corporate currency for the sales forecast quota.",
            "nullable":true,
            "x-queryable":true
        },
        "DsQuotaId":{
            "title":"Quota ID",
            "type":"integer",
            "description":"The quota ID for the sales forecast quota.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the sales forecast quota was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the sales forecast quota.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the sales forecast quota.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricCode":{
            "title":"Target Type",
            "maxLength":100,
            "type":"string",
            "description":"The metric code for the sales forecast quota.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricDimFiveCode":{
            "maxLength":100,
            "type":"string",
            "description":"The metric code for the fifth dimension of sales forecast quota.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDimFourCode":{
            "maxLength":100,
            "type":"string",
            "description":"The metric code for the fourth dimension of sales forecast quota.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDimOneCode":{
            "maxLength":100,
            "type":"string",
            "description":"The metric code for the first dimension of sales forecast quota.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDimThreeCode":{
            "maxLength":100,
            "type":"string",
            "description":"The metric code for the third dimension of sales forecast quota.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDimTwoCode":{
            "maxLength":100,
            "type":"string",
            "description":"The metric code for the second dimension of sales forecast quota.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDimensionFiveKey":{
            "title":"Dimension 5",
            "maxLength":300,
            "type":"string",
            "description":"The metric key for the fifth dimension of sales forecast quota.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricDimensionFourKey":{
            "title":"Dimension 4",
            "maxLength":300,
            "type":"string",
            "description":"The metric key for the fourth dimension of sales forecast quota.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricDimensionOneKey":{
            "title":"Dimension 1",
            "maxLength":300,
            "type":"string",
            "description":"The metric key for the first dimension of sales forecast quota.",
            "nullable":false,
            "x-queryable":true
        },
        "MetricDimensionThreeKey":{
            "title":"Dimension 3",
            "maxLength":300,
            "type":"string",
            "description":"The metric key for the third dimension of sales forecast quota.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricDimensionTwoKey":{
            "title":"Dimension 2",
            "maxLength":300,
            "type":"string",
            "description":"The metric key for the second dimension of sales forecast quota.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricSrcCode":{
            "maxLength":100,
            "type":"string",
            "description":"The metric source code for the sales forecast quota.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricValue":{
            "type":"number",
            "description":"The metric value in the entered currency for the sales forecast quota.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the sales forecast quota.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "QuotaNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The quota number for the sales forecast quota.",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceQuotaEffectiveDate":{
            "title":"Effective Date",
            "type":"string",
            "description":"The resource quota effective date used to identify the period for the sales forecast quota.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top