Jump to

• Request
• Response

Update a metric source dimension mapping

patch

/crmRestApi/resources/11.13.18.05/salesForecastMetricSourceDimensionMappings/{MetricSrcDimMapId}

Request

Path Parameters

• MetricSrcDimMapId(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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• FilterFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether metric source dimension mapping is used for filtering forecasts. The values accepted are true or false.
• MetricDimAttr: string
  Maximum Length: 1000

  The metric dimension attribute of the sales forecast metric source dimension mapping.
• MultiSelectFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the metric source dimension mapping filter allows selecting multiple values.The values accepted are true or false.

{
    "type":"object",
    "properties":{
        "FilterFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether metric source dimension mapping is used for filtering forecasts. The values accepted are true or false.",
            "nullable":true,
            "default":false
        },
        "MetricDimAttr":{
            "maxLength":"1000",
            "type":"string",
            "description":"The metric dimension attribute of the sales forecast metric source dimension mapping.",
            "nullable":false
        },
        "MultiSelectFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the metric source dimension mapping filter allows selecting multiple values.The values accepted are true or false.",
            "nullable":true,
            "default":false
        }
    }
}

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 : salesForecastMetricSourceDimensionMappings-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the sales forecast metric source dimension mapping.
• CreationDate: string (date-time)
  Read Only: true

  The date when the sales forecast metric source dimension mapping was created.
• DimType: string
  Read Only: true

  Maximum Length: 30

  The dimension type of a metric source dimension mapping.
• FilterFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether metric source dimension mapping is used for filtering forecasts. The values accepted are true or false.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the sales forecast metric source dimension mapping was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the sales forecast metric source dimension mapping.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the sales forecast metric source dimension mapping.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MetricDimAttr: string
  Maximum Length: 1000

  The metric dimension attribute of the sales forecast metric source dimension mapping.
• MetricDimCode: string
  Maximum Length: 100

  The code that uniquely identifies a sales forecast metric source dimension mapping such as TERRITORY and PRODUCT.
• MetricSrcCode: string
  Maximum Length: 100

  The metric source code of the sales forecast metric source dimension mapping.
• MetricSrcDimMapId: integer (int64)
  The metric source dimension mapping identifier for the sales forecast metric source dimension mapping.
• MultiSelectFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the metric source dimension mapping filter allows selecting multiple values.The values accepted are true or false.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number for the sales forecast metric source dimension mapping.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the sales forecast metric source dimension mapping.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the sales forecast metric source dimension mapping was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the sales forecast metric source dimension mapping.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MetricDimAttr":{
            "maxLength":"1000",
            "type":"string",
            "description":"The metric dimension attribute of the sales forecast metric source dimension mapping.",
            "nullable":false,
            "x-queryable":true
        },
        "MultiSelectFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the metric source dimension mapping filter allows selecting multiple values.The values accepted are true or false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "MetricDimCode":{
            "maxLength":"100",
            "type":"string",
            "description":"The code that uniquely identifies a sales forecast metric source dimension mapping such as TERRITORY and PRODUCT.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the sales forecast metric source dimension mapping.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MetricSrcCode":{
            "maxLength":"100",
            "type":"string",
            "description":"The metric source code of the sales forecast metric source dimension mapping.",
            "nullable":false,
            "x-queryable":true
        },
        "MetricSrcDimMapId":{
            "type":"integer",
            "description":"The metric source dimension mapping identifier for the sales forecast metric source dimension mapping.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FilterFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether metric source dimension mapping is used for filtering forecasts. The values accepted are true or false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "DimType":{
            "maxLength":"30",
            "type":"string",
            "description":"The dimension type of a metric source dimension mapping.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the sales forecast metric source dimension mapping 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 metric source dimension mapping.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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