Update an attribute value
patch
/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}/child/ProductGroupAttributeValueSetup/{ProdGrpAtvalId}
Request
Path Parameters
-
ProdGroupId(required): integer(int64)
The unique identifier of the product group.
-
ProdGrpAttrId(required): integer(int64)
The unique identifier of the product group attribute value.
-
ProdGrpAtvalId(required): integer(int64)
The unique identifier of the product group attribute value.
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
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
AttrValueName: string
Title:
Display
Maximum Length:150
The name of the attribute value. -
AttrValueText: string
Title:
Internal Value
Maximum Length:150
The text corresponding to attribute value. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code of the product's registered price and amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
DisplayOrderNum: integer
(int64)
Title:
Display Sequence
The manually set display order for attribute domain. -
MaxValueNum: number
Title:
Maximum Value
The maximum numeric value in a range. -
MinValueNum: number
Title:
Minimum Value
The minimum numeric value in a range. -
ProdGroupId: integer
(int64)
The unique identifier of the product group.
-
ProdGrpAtvalId: integer
(int64)
The unique identifier of the product group attribute value.
-
ValueId: integer
(int64)
Title:
Value
The unique identifier of the value.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : setupSalesCatalogs-ProductGroupAttributeSetup-ProductGroupAttributeValueSetup-item-response
Type:
Show Source
object
-
AttrValueName: string
Title:
Display
Maximum Length:150
The name of the attribute value. -
AttrValueText: string
Title:
Internal Value
Maximum Length:150
The text corresponding to attribute value. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code of the product's registered price and amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
DisplayOrderNum: integer
(int64)
Title:
Display Sequence
The manually set display order for attribute domain. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaxValueNum: number
Title:
Maximum Value
The maximum numeric value in a range. -
MinValueNum: number
Title:
Minimum Value
The minimum numeric value in a range. -
ProdGroupId: integer
(int64)
The unique identifier of the product group.
-
ProdGrpAtvalId: integer
(int64)
The unique identifier of the product group attribute value.
-
ValueId: integer
(int64)
Title:
Value
The unique identifier of the value.
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.