Jump to

• Request
• Response

Update a dimension metadata record

patch

/crmRestApi/resources/11.13.18.05/salesForecastDimensionMetadata/{MetricDimMetaId}

Request

Path Parameters

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

• DimSourceFilterCriteria: string
  Maximum Length: 4000

  The dimension source filter criteria for the sales forecast dimension metadata is the criteria applied on the dimension source to restrict the values used when creating the dimension.
• DimSourceKeyAttr: string
  Maximum Length: 1000

  The name of the attribute that's the unique identifier of the dimension source for the sales forecast dimension metadata.
• DimSourceName: string
  Maximum Length: 1000

  The name of the dimension source for the sales forecast dimension metadata. This identifies the data source of a dimension. For lookup based dimensions, this is the lookup type value. For standard or custom object based dimensions this is a valid object name.
• DimSourceNameAttr: string
  Maximum Length: 1000

  The dimension source name attribute for the sales forecast dimension metadata is the attribute name that contains the name of the dimension source.
• DimSourceOwnerKeyAttr: string
  Maximum Length: 1000

  The dimension source owner key attribute for the sales forecast dimension metadata is the name of the dimension source attribute that contains the unique identifier of the owner. This is relevant when a dimension represents a sales forecast participant.
• DimSourceParentKeyAttr: string
  Maximum Length: 1000

  The dimension source parent key attribute for the sales forecast dimension metadata is the name of the primary key attribute that identifies the parent of the dimension source. This is relevant when a dimension is hierarchical.
• DimSourceType: string
  Maximum Length: 30

  The type of dimension source which can be based on a lookup type, standard object or custom object. The values accepted are LOOKUP or CUSTOM.

{
    "type":"object",
    "properties":{
        "DimSourceType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of dimension source which can be based on a lookup type, standard object or custom object. The values accepted are LOOKUP or CUSTOM.",
            "nullable":false
        },
        "DimSourceParentKeyAttr":{
            "maxLength":"1000",
            "type":"string",
            "description":"The dimension source parent key attribute for the sales forecast dimension metadata is the name of the primary key attribute that identifies the parent of the dimension source. This is relevant when a dimension is hierarchical.",
            "nullable":true
        },
        "DimSourceNameAttr":{
            "maxLength":"1000",
            "type":"string",
            "description":"The dimension source name attribute for the sales forecast dimension metadata is the attribute name that contains the name of the dimension source.",
            "nullable":true
        },
        "DimSourceOwnerKeyAttr":{
            "maxLength":"1000",
            "type":"string",
            "description":"The dimension source owner key attribute for the sales forecast dimension metadata is the name of the dimension source attribute that contains the unique identifier of the owner. This is relevant when a dimension represents a sales forecast participant.",
            "nullable":true
        },
        "DimSourceName":{
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the dimension source for the sales forecast dimension metadata. This identifies the data source of a dimension. For lookup based dimensions, this is the lookup type value. For standard or custom object based dimensions this is a valid object name.",
            "nullable":false
        },
        "DimSourceKeyAttr":{
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the attribute that's the unique identifier of the dimension source for the sales forecast dimension metadata.",
            "nullable":true
        },
        "DimSourceFilterCriteria":{
            "maxLength":"4000",
            "type":"string",
            "description":"The dimension source filter criteria for the sales forecast dimension metadata is the criteria applied on the dimension source to restrict the values used when creating the dimension.",
            "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 : salesForecastDimensionMetadata-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the sales forecast dimension metadata was created.
• DimSourceFilterCriteria: string
  Maximum Length: 4000

  The dimension source filter criteria for the sales forecast dimension metadata is the criteria applied on the dimension source to restrict the values used when creating the dimension.
• DimSourceKeyAttr: string
  Maximum Length: 1000

  The name of the attribute that's the unique identifier of the dimension source for the sales forecast dimension metadata.
• DimSourceName: string
  Maximum Length: 1000

  The name of the dimension source for the sales forecast dimension metadata. This identifies the data source of a dimension. For lookup based dimensions, this is the lookup type value. For standard or custom object based dimensions this is a valid object name.
• DimSourceNameAttr: string
  Maximum Length: 1000

  The dimension source name attribute for the sales forecast dimension metadata is the attribute name that contains the name of the dimension source.
• DimSourceOwnerKeyAttr: string
  Maximum Length: 1000

  The dimension source owner key attribute for the sales forecast dimension metadata is the name of the dimension source attribute that contains the unique identifier of the owner. This is relevant when a dimension represents a sales forecast participant.
• DimSourceParentKeyAttr: string
  Maximum Length: 1000

  The dimension source parent key attribute for the sales forecast dimension metadata is the name of the primary key attribute that identifies the parent of the dimension source. This is relevant when a dimension is hierarchical.
• DimSourceType: string
  Maximum Length: 30

  The type of dimension source which can be based on a lookup type, standard object or custom object. The values accepted are LOOKUP or CUSTOM.
• KeyMapSql: string
  Read Only: true

  Maximum Length: 4000

  The key map SQL statement for the sales forecast dimension metadata is generated when the dimension source type is lookup.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• MetricDimCode: string
  Maximum Length: 100

  The code that uniquely identifies a sales forecast metric dimension such as TERRITORY and PRODUCT.
• MetricDimMetaId: integer (int64)
  The metric dimension metadata identifier for the sales forecast metric dimension metadata is a generated primary key to uniquely identify each metadata record.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number for the sales forecast dimension metadata.
• RootDimKeySql: string
  Read Only: true

  Maximum Length: 4000

  The root dimension key SQL statement for the sales forecast dimension metadata is generated based on the dimension source.
• SourceSql: string
  Read Only: true

  Maximum Length: 4000

  The source SQL statement for the sales forecast dimension metadata is generated for lookup and object based dimensions.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the sales forecast dimension metadata.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DimSourceType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of dimension source which can be based on a lookup type, standard object or custom object. The values accepted are LOOKUP or CUSTOM.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the sales forecast dimension metadata was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DimSourceOwnerKeyAttr":{
            "maxLength":"1000",
            "type":"string",
            "description":"The dimension source owner key attribute for the sales forecast dimension metadata is the name of the dimension source attribute that contains the unique identifier of the owner. This is relevant when a dimension represents a sales forecast participant.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the sales forecast dimension metadata.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceSql":{
            "maxLength":"4000",
            "type":"string",
            "description":"The source SQL statement for the sales forecast dimension metadata is generated for lookup and object based dimensions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DimSourceKeyAttr":{
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the attribute that's the unique identifier of the dimension source for the sales forecast dimension metadata.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricDimCode":{
            "maxLength":"100",
            "type":"string",
            "description":"The code that uniquely identifies a sales forecast metric dimension such as TERRITORY and PRODUCT.",
            "nullable":false,
            "x-queryable":true
        },
        "MetricDimMetaId":{
            "type":"integer",
            "description":"The metric dimension metadata identifier for the sales forecast metric dimension metadata is a generated primary key to uniquely identify each metadata record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DimSourceParentKeyAttr":{
            "maxLength":"1000",
            "type":"string",
            "description":"The dimension source parent key attribute for the sales forecast dimension metadata is the name of the primary key attribute that identifies the parent of the dimension source. This is relevant when a dimension is hierarchical.",
            "nullable":true,
            "x-queryable":true
        },
        "DimSourceNameAttr":{
            "maxLength":"1000",
            "type":"string",
            "description":"The dimension source name attribute for the sales forecast dimension metadata is the attribute name that contains the name of the dimension source.",
            "nullable":true,
            "x-queryable":true
        },
        "KeyMapSql":{
            "maxLength":"4000",
            "type":"string",
            "description":"The key map SQL statement for the sales forecast dimension metadata is generated when the dimension source type is lookup.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DimSourceName":{
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the dimension source for the sales forecast dimension metadata. This identifies the data source of a dimension. For lookup based dimensions, this is the lookup type value. For standard or custom object based dimensions this is a valid object name.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the sales forecast dimension metadata.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "RootDimKeySql":{
            "maxLength":"4000",
            "type":"string",
            "description":"The root dimension key SQL statement for the sales forecast dimension metadata is generated based on the dimension source.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DimSourceFilterCriteria":{
            "maxLength":"4000",
            "type":"string",
            "description":"The dimension source filter criteria for the sales forecast dimension metadata is the criteria applied on the dimension source to restrict the values used when creating the dimension.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the sales forecast dimension metadata 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 dimension metadata.",
            "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