Jump to

• Request
• Response
• Examples

Update an attribute by product group attribute ID

patch

/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}

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.

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

• AttributeOptionId: integer (int64)
  Title: Option ID

  The unique identifier of the product group attribute option.
• AttrName: string
  Title: Display

  Maximum Length: 250

  The name of the product group attribute.
• DisplayOrderNum: integer (int64)
  Title: Display Sequence

  The manually set display order for attributes of a product group.
• ProdGroupId(required): integer (int64)
  The unique identifier of the product group.
• ProdGrpAttrId: integer (int64)
  The unique identifier of the product group attribute value.
• ProductGroupAttributeValueSetup: array Filter Attribute Values
  Title: Filter Attribute Values

  The filter attribute values resource is used to view, create, update, and delete the values of the filter attributes associated with a product group. For example, values such as Blue or Red for the color filter attribute.

{
    "required":[
        "ProdGroupId"
    ],
    "type":"object",
    "properties":{
        "AttrName":{
            "title":"Display",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the product group attribute.",
            "nullable":true
        },
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProductGroupAttributeValueSetup":{
            "title":"Filter Attribute Values",
            "type":"array",
            "description":"The filter attribute values resource is used to view, create, update, and delete the values of the filter attributes associated with a product group. For example, values such as Blue or Red for the color filter attribute.",
            "items":{
                "$ref":"#/components/schemas/setupSalesCatalogs-ProductGroupAttributeSetup-ProductGroupAttributeValueSetup-item-patch-request"
            }
        },
        "DisplayOrderNum":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The manually set display order for attributes of a product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProdGrpAttrId":{
            "type":"integer",
            "description":"The unique identifier of the product group attribute value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AttributeOptionId":{
            "title":"Option ID",
            "type":"integer",
            "description":"The unique identifier of the product group attribute option.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        }
    }
}

Nested Schema : Filter Attribute Values

Type: array

Title: Filter Attribute Values

The filter attribute values resource is used to view, create, update, and delete the values of the filter attributes associated with a product group. For example, values such as Blue or Red for the color filter attribute.

Show Source

• Array of: object setupSalesCatalogs-ProductGroupAttributeSetup-ProductGroupAttributeValueSetup-item-patch-request

{
    "title":"Filter Attribute Values",
    "type":"array",
    "description":"The filter attribute values resource is used to view, create, update, and delete the values of the filter attributes associated with a product group. For example, values such as Blue or Red for the color filter attribute.",
    "items":{
        "$ref":"#/components/schemas/setupSalesCatalogs-ProductGroupAttributeSetup-ProductGroupAttributeValueSetup-item-patch-request"
    }
}

Nested Schema : setupSalesCatalogs-ProductGroupAttributeSetup-ProductGroupAttributeValueSetup-item-patch-request

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DisplayOrderNum":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The manually set display order for attribute domain.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "MaxValueNum":{
            "title":"Maximum Value",
            "type":"number",
            "description":"The maximum numeric value in a range.",
            "nullable":true,
            "x-hints":{
                "precision":"22",
                "scale":"7"
            }
        },
        "ProdGrpAtvalId":{
            "type":"integer",
            "description":"The unique identifier of the product group attribute value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AttrValueText":{
            "title":"Internal Value",
            "maxLength":"150",
            "type":"string",
            "description":"The text corresponding to attribute value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MinValueNum":{
            "title":"Minimum Value",
            "type":"number",
            "description":"The minimum numeric value in a range.",
            "nullable":true,
            "x-hints":{
                "precision":"22",
                "scale":"7"
            }
        },
        "ValueId":{
            "title":"Value",
            "type":"integer",
            "description":"The unique identifier of the value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "AttrValueName":{
            "title":"Display",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the attribute value.",
            "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 : setupSalesCatalogs-ProductGroupAttributeSetup-item-response

Type: object

Show Source

• AttributeOptionId: integer (int64)
  Title: Option ID

  The unique identifier of the product group attribute option.
• AttrName: string
  Title: Display

  Maximum Length: 250

  The name of the product group attribute.
• DisplayOrderNum: integer (int64)
  Title: Display Sequence

  The manually set display order for attributes of a product group.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProdGroupId: integer (int64)
  The unique identifier of the product group.
• ProdGrpAttrId: integer (int64)
  The unique identifier of the product group attribute value.
• ProductGroupAttributeValueSetup: array Filter Attribute Values
  Title: Filter Attribute Values

  The filter attribute values resource is used to view, create, update, and delete the values of the filter attributes associated with a product group. For example, values such as Blue or Red for the color filter attribute.
• ValueSetId: integer (int64)
  Read Only: true

  The unique identifier of the value set used for mapping to get the AttrValueText from TranslatableIndependentValueSetValuePVO.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ValueSetId":{
            "type":"integer",
            "description":"The unique identifier of the value set used for mapping to get the AttrValueText from TranslatableIndependentValueSetValuePVO.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttrName":{
            "title":"Display",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the product group attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProductGroupAttributeValueSetup":{
            "title":"Filter Attribute Values",
            "type":"array",
            "description":"The filter attribute values resource is used to view, create, update, and delete the values of the filter attributes associated with a product group. For example, values such as Blue or Red for the color filter attribute.",
            "items":{
                "$ref":"#/components/schemas/setupSalesCatalogs-ProductGroupAttributeSetup-ProductGroupAttributeValueSetup-item-response"
            }
        },
        "DisplayOrderNum":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The manually set display order for attributes of a product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttributeOptionId":{
            "title":"Option ID",
            "type":"integer",
            "description":"The unique identifier of the product group attribute option.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProdGrpAttrId":{
            "type":"integer",
            "description":"The unique identifier of the product group attribute value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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 : Filter Attribute Values

Type: array

Title: Filter Attribute Values

The filter attribute values resource is used to view, create, update, and delete the values of the filter attributes associated with a product group. For example, values such as Blue or Red for the color filter attribute.

Show Source

• Array of: object setupSalesCatalogs-ProductGroupAttributeSetup-ProductGroupAttributeValueSetup-item-response

{
    "title":"Filter Attribute Values",
    "type":"array",
    "description":"The filter attribute values resource is used to view, create, update, and delete the values of the filter attributes associated with a product group. For example, values such as Blue or Red for the color filter attribute.",
    "items":{
        "$ref":"#/components/schemas/setupSalesCatalogs-ProductGroupAttributeSetup-ProductGroupAttributeValueSetup-item-response"
    }
}

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."
        }
    }
}

Nested Schema : setupSalesCatalogs-ProductGroupAttributeSetup-ProductGroupAttributeValueSetup-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DisplayOrderNum":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The manually set display order for attribute domain.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MaxValueNum":{
            "title":"Maximum Value",
            "type":"number",
            "description":"The maximum numeric value in a range.",
            "nullable":true,
            "x-hints":{
                "precision":"22",
                "scale":"7"
            },
            "x-queryable":true
        },
        "ProdGrpAtvalId":{
            "type":"integer",
            "description":"The unique identifier of the product group attribute value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttrValueText":{
            "title":"Internal Value",
            "maxLength":"150",
            "type":"string",
            "description":"The text corresponding to attribute value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MinValueNum":{
            "title":"Minimum Value",
            "type":"number",
            "description":"The minimum numeric value in a range.",
            "nullable":true,
            "x-hints":{
                "precision":"22",
                "scale":"7"
            },
            "x-queryable":true
        },
        "ValueId":{
            "title":"Value",
            "type":"integer",
            "description":"The unique identifier of the value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttrValueName":{
            "title":"Display",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the attribute value.",
            "nullable":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"
    }
}

Links

ProductGroupAttributeValueSetup

Operation: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}/child/ProductGroupAttributeValueSetup

Parameters:

• ProdGroupId: $request.path.ProdGroupId
• ProdGrpAttrId: $request.path.ProdGrpAttrId

The filter attribute values resource is used to view, create, update, and delete the values of the filter attributes associated with a product group. For example, values such as Blue or Red for the color filter attribute.

Back to Top

Examples

cURL Command

The following example shows how to update an attribute by product group attribute Id by submitting a patch request on the REST resource using cURL

curl --user sales_cloud_user -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/300100074788637/child/ProductGroupAttributeSetup/300100074788648

Example of Request Body

The following shows an example of the request body in JSON format.

{
      "AttrName": null,
      "AttributeOptionId": 100000010407001,
      "DisplayOrderNum": 1
    }

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "AttrName": null,
  "AttributeOptionId": 100000010407001,
  "DisplayOrderNum": 1,
  "LastUpdatedBy": "SALES_ADMIN",
  "ProdGroupId": 300100074788637,
  "ProdGrpAttrId": 300100074788648,
  "ValueSetId": null,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/300100074788637/child/ProductGroupAttributeSetup/300100074788648",
      "name": "ProductGroupAttributeSetup",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000004737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/300100074788637/child/ProductGroupAttributeSetup/300100074788648",
      "name": "ProductGroupAttributeSetup",
      "kind": "item"
    },
    {
      "rel": "parent",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/300100074788637",
      "name": "setupSalesCatalogs",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/300100074788637/child/ProductGroupAttributeSetup/300100074788648/lov/ProductGroupAttributeOptionSetupVO",
      "name": "ProductGroupAttributeOptionSetupVO",
      "kind": "collection"
    },
    {
      "rel": "child",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/300100074788637/child/ProductGroupAttributeSetup/300100074788648/child/ProductGroupAttributeValueSetup",
      "name": "ProductGroupAttributeValueSetup",
      "kind": "collection"
    }
  ]
}

Back to Top