Jump to

• Request
• Response

Update a metric source attribute

patch

/crmRestApi/resources/11.13.18.05/salesForecastMetricSources/{MetricSrcCode}/child/MetricSrcAttributes/{MetricSrcAttributesUniqID}

Request

Path Parameters

• MetricSrcAttributesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- MetricSrcCode and AttributeCode ---for the Metric Source Attributes resource and used to uniquely identify an instance of Metric Source Attributes. The client should not generate the hash key value. Instead, the client should query on the Metric Source Attributes collection resource with a filter on the primary key values in order to navigate to a specific instance of Metric Source Attributes.
  
  For example: MetricSrcAttributes?q=MetricSrcCode=<value1>;AttributeCode=<value2>
• MetricSrcCode(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

• AliasName: string
  The alias name for the metric source attribute.
• AttrColumn: string
  The attribute column for the metric source attribute.
• AttributeCode: string
  The attribute code for the metric source attribute.
• AttributeDefType: string
  The attribute definition type for the metric source attribute.
• AttributeTable: string
  The attribute table for the metric source attribute.
• AttributeType: string
  The attribute type for the metric source attribute.
• AttrLength: number
  The attribute length for the metric source attribute.
• AttrPrecision: number
  The attribute precision for the metric source attribute.
• AttrScale: number
  The attribute scale for the metric source attribute.
• ColumnType: string
  The column type for the metric source attribute.
• CreatedBy: string
  The user who created the metric source attribute.
• CreationDate: string (date-time)
  The date when the metric source attribute was created.
• DefaultValue: string
  The default value for the metric source attribute.
• DependsOn: string
  The dependent attributes for the metric source attribute.
• Description: string
  The description for the metric source attribute.
• DescriptionResourceId: string
  The description resource identifier for the metric source attribute.
• DisplayName: string
  The display name for the metric source attribute.
• EntityUsage: string
  The entity usage for the metric source attribute.
• IsCustomFlag: boolean
  The custom attribute flag for the metric source attribute.
• IsQueryableFlag: boolean
  Indicates whether the metric source attribute can be queried.
• IsSQLDerivedExprFlag: boolean
  The SQL derived expression flag for the metric source attribute.
• IsUpdatableFlag: boolean
  The updatable flag for the metric source attribute.
• LabelResourceId: string
  The label resource identifier for the metric source attribute.
• LastUpdateDate: string (date-time)
  The date when the metric source attribute was last updated.
• LastUpdatedBy: string
  The user who last updated the metric source attribute.
• MandatoryFlag: boolean
  The mandatory flag for the metric source attribute.
• MetricSrcCode: string
  The metric source code for the metric source attribute.
• SignalAttributeName: string
  The signal attribute name for the metric source attribute.
• SignalAttributeType: string
  The signal attribute type for the metric source attribute.
• SignalFormattedAttributeName: string
  The formatted signal attribute name for the metric source attribute.
• SignalObject: string
  The signal object for the metric source attribute.
• SignalObjectType: string
  The signal object type for the metric source attribute.
• SignalRelatedObject: string
  The related signal object for the metric source attribute.
• SignalRelatedObjectCode: string
  The related signal object code for the metric source attribute.
• SignalRelatedObjectType: string
  The related signal object type for the metric source attribute.
• TableName: string
  The table name for the metric source attribute.
• TransientFlag: boolean
  The transient flag for the metric source attribute.

{
    "type":"object",
    "properties":{
        "AliasName":{
            "type":"string",
            "description":"The alias name for the metric source attribute.",
            "nullable":true
        },
        "AttrColumn":{
            "type":"string",
            "description":"The attribute column for the metric source attribute.",
            "nullable":true
        },
        "AttrLength":{
            "type":"number",
            "description":"The attribute length for the metric source attribute.",
            "nullable":true
        },
        "AttrPrecision":{
            "type":"number",
            "description":"The attribute precision for the metric source attribute.",
            "nullable":true
        },
        "AttrScale":{
            "type":"number",
            "description":"The attribute scale for the metric source attribute.",
            "nullable":true
        },
        "AttributeCode":{
            "type":"string",
            "description":"The attribute code for the metric source attribute.",
            "nullable":true
        },
        "AttributeDefType":{
            "type":"string",
            "description":"The attribute definition type for the metric source attribute.",
            "nullable":true
        },
        "AttributeTable":{
            "type":"string",
            "description":"The attribute table for the metric source attribute.",
            "nullable":true
        },
        "AttributeType":{
            "type":"string",
            "description":"The attribute type for the metric source attribute.",
            "nullable":true
        },
        "ColumnType":{
            "type":"string",
            "description":"The column type for the metric source attribute.",
            "nullable":true
        },
        "CreatedBy":{
            "type":"string",
            "description":"The user who created the metric source attribute.",
            "nullable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the metric source attribute was created.",
            "format":"date-time",
            "nullable":true
        },
        "DefaultValue":{
            "type":"string",
            "description":"The default value for the metric source attribute.",
            "nullable":true
        },
        "DependsOn":{
            "type":"string",
            "description":"The dependent attributes for the metric source attribute.",
            "nullable":true
        },
        "Description":{
            "type":"string",
            "description":"The description for the metric source attribute.",
            "nullable":true
        },
        "DescriptionResourceId":{
            "type":"string",
            "description":"The description resource identifier for the metric source attribute.",
            "nullable":true
        },
        "DisplayName":{
            "type":"string",
            "description":"The display name for the metric source attribute.",
            "nullable":true
        },
        "EntityUsage":{
            "type":"string",
            "description":"The entity usage for the metric source attribute.",
            "nullable":true
        },
        "IsCustomFlag":{
            "type":"boolean",
            "description":"The custom attribute flag for the metric source attribute.",
            "nullable":true
        },
        "IsQueryableFlag":{
            "type":"boolean",
            "description":"Indicates whether the metric source attribute can be queried.",
            "nullable":true
        },
        "IsSQLDerivedExprFlag":{
            "type":"boolean",
            "description":"The SQL derived expression flag for the metric source attribute.",
            "nullable":true
        },
        "IsUpdatableFlag":{
            "type":"boolean",
            "description":"The updatable flag for the metric source attribute.",
            "nullable":true
        },
        "LabelResourceId":{
            "type":"string",
            "description":"The label resource identifier for the metric source attribute.",
            "nullable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the metric source attribute was last updated.",
            "format":"date-time",
            "nullable":true
        },
        "LastUpdatedBy":{
            "type":"string",
            "description":"The user who last updated the metric source attribute.",
            "nullable":true
        },
        "MandatoryFlag":{
            "type":"boolean",
            "description":"The mandatory flag for the metric source attribute.",
            "nullable":true
        },
        "MetricSrcCode":{
            "type":"string",
            "description":"The metric source code for the metric source attribute.",
            "nullable":true
        },
        "SignalAttributeName":{
            "type":"string",
            "description":"The signal attribute name for the metric source attribute.",
            "nullable":true
        },
        "SignalAttributeType":{
            "type":"string",
            "description":"The signal attribute type for the metric source attribute.",
            "nullable":true
        },
        "SignalFormattedAttributeName":{
            "type":"string",
            "description":"The formatted signal attribute name for the metric source attribute.",
            "nullable":true
        },
        "SignalObject":{
            "type":"string",
            "description":"The signal object for the metric source attribute.",
            "nullable":true
        },
        "SignalObjectType":{
            "type":"string",
            "description":"The signal object type for the metric source attribute.",
            "nullable":true
        },
        "SignalRelatedObject":{
            "type":"string",
            "description":"The related signal object for the metric source attribute.",
            "nullable":true
        },
        "SignalRelatedObjectCode":{
            "type":"string",
            "description":"The related signal object code for the metric source attribute.",
            "nullable":true
        },
        "SignalRelatedObjectType":{
            "type":"string",
            "description":"The related signal object type for the metric source attribute.",
            "nullable":true
        },
        "TableName":{
            "type":"string",
            "description":"The table name for the metric source attribute.",
            "nullable":true
        },
        "TransientFlag":{
            "type":"boolean",
            "description":"The transient flag for the metric source attribute.",
            "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 : salesForecastMetricSources-MetricSrcAttributes-item-response

Type: object

Show Source

• AliasName: string
  The alias name for the metric source attribute.
• AttrColumn: string
  The attribute column for the metric source attribute.
• AttributeCode: string
  The attribute code for the metric source attribute.
• AttributeDefType: string
  The attribute definition type for the metric source attribute.
• AttributeTable: string
  The attribute table for the metric source attribute.
• AttributeType: string
  The attribute type for the metric source attribute.
• AttrLength: number
  The attribute length for the metric source attribute.
• AttrPrecision: number
  The attribute precision for the metric source attribute.
• AttrScale: number
  The attribute scale for the metric source attribute.
• ColumnType: string
  The column type for the metric source attribute.
• CreatedBy: string
  The user who created the metric source attribute.
• CreationDate: string (date-time)
  The date when the metric source attribute was created.
• DefaultValue: string
  The default value for the metric source attribute.
• DependsOn: string
  The dependent attributes for the metric source attribute.
• Description: string
  The description for the metric source attribute.
• DescriptionResourceId: string
  The description resource identifier for the metric source attribute.
• DisplayName: string
  The display name for the metric source attribute.
• EntityUsage: string
  The entity usage for the metric source attribute.
• IsCustomFlag: boolean
  The custom attribute flag for the metric source attribute.
• IsQueryableFlag: boolean
  Indicates whether the metric source attribute can be queried.
• IsSQLDerivedExprFlag: boolean
  The SQL derived expression flag for the metric source attribute.
• IsUpdatableFlag: boolean
  The updatable flag for the metric source attribute.
• LabelResourceId: string
  The label resource identifier for the metric source attribute.
• LastUpdateDate: string (date-time)
  The date when the metric source attribute was last updated.
• LastUpdatedBy: string
  The user who last updated the metric source attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  The mandatory flag for the metric source attribute.
• MetricSrcCode: string
  The metric source code for the metric source attribute.
• SignalAttributeName: string
  The signal attribute name for the metric source attribute.
• SignalAttributeType: string
  The signal attribute type for the metric source attribute.
• SignalFormattedAttributeName: string
  The formatted signal attribute name for the metric source attribute.
• SignalObject: string
  The signal object for the metric source attribute.
• SignalObjectType: string
  The signal object type for the metric source attribute.
• SignalRelatedObject: string
  The related signal object for the metric source attribute.
• SignalRelatedObjectCode: string
  The related signal object code for the metric source attribute.
• SignalRelatedObjectType: string
  The related signal object type for the metric source attribute.
• TableName: string
  The table name for the metric source attribute.
• TransientFlag: boolean
  The transient flag for the metric source attribute.

{
    "type":"object",
    "properties":{
        "AliasName":{
            "type":"string",
            "description":"The alias name for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttrColumn":{
            "type":"string",
            "description":"The attribute column for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttrLength":{
            "type":"number",
            "description":"The attribute length for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttrPrecision":{
            "type":"number",
            "description":"The attribute precision for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttrScale":{
            "type":"number",
            "description":"The attribute scale for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeCode":{
            "type":"string",
            "description":"The attribute code for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDefType":{
            "type":"string",
            "description":"The attribute definition type for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeTable":{
            "type":"string",
            "description":"The attribute table for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeType":{
            "type":"string",
            "description":"The attribute type for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ColumnType":{
            "type":"string",
            "description":"The column type for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "type":"string",
            "description":"The user who created the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the metric source attribute was created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultValue":{
            "type":"string",
            "description":"The default value for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DependsOn":{
            "type":"string",
            "description":"The dependent attributes for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "type":"string",
            "description":"The description for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DescriptionResourceId":{
            "type":"string",
            "description":"The description resource identifier for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayName":{
            "type":"string",
            "description":"The display name for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "EntityUsage":{
            "type":"string",
            "description":"The entity usage for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "IsCustomFlag":{
            "type":"boolean",
            "description":"The custom attribute flag for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "IsQueryableFlag":{
            "type":"boolean",
            "description":"Indicates whether the metric source attribute can be queried.",
            "nullable":true,
            "x-queryable":true
        },
        "IsSQLDerivedExprFlag":{
            "type":"boolean",
            "description":"The SQL derived expression flag for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "IsUpdatableFlag":{
            "type":"boolean",
            "description":"The updatable flag for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LabelResourceId":{
            "type":"string",
            "description":"The label resource identifier for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the metric source attribute was last updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "type":"string",
            "description":"The user who last updated the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "type":"boolean",
            "description":"The mandatory flag for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "MetricSrcCode":{
            "type":"string",
            "description":"The metric source code for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "SignalAttributeName":{
            "type":"string",
            "description":"The signal attribute name for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "SignalAttributeType":{
            "type":"string",
            "description":"The signal attribute type for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "SignalFormattedAttributeName":{
            "type":"string",
            "description":"The formatted signal attribute name for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "SignalObject":{
            "type":"string",
            "description":"The signal object for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "SignalObjectType":{
            "type":"string",
            "description":"The signal object type for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "SignalRelatedObject":{
            "type":"string",
            "description":"The related signal object for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "SignalRelatedObjectCode":{
            "type":"string",
            "description":"The related signal object code for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "SignalRelatedObjectType":{
            "type":"string",
            "description":"The related signal object type for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "TableName":{
            "type":"string",
            "description":"The table name for the metric source attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "TransientFlag":{
            "type":"boolean",
            "description":"The transient flag for the metric source attribute.",
            "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