Set values for dictionary Category Level Attribute (CLA) and schedule propagation task.

post

https://api.test.bluestonepim.com/pim/catalogs/nodes/{id}/attributes/{attributeDefinitionId}/dictionary/values

Replaces the selected dictionary values with exactly the set sent in the body: values left out are unselected
and an empty list clears the selection. The attribute is attached to the category first when it is not there
yet, which makes POST /catalogs/nodes/{id}/attributes/{attributeDefinitionId}/dictionary optional. Fails
when a value ID does not belong to this attribute definition or when the definition's limit on the number of
selected values would be exceeded.

The selection is stored on the category immediately, while copying it onto products runs as a background task.
That task covers the products in this category, and the products in its sub-categories only while propagation is
on for this attribute. The task ID is returned in the Resource-Id response header and Location points at
GET /async/status/{taskId}, which reports whether the propagation has finished.

For more detailed information on how to work with Category Level Attributes in Bluestone PIM, refer to our help
pages Category Level Attributes (CLA).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The ID for the catalog node/category.

Example: 634c26e14cedfd0001775e9f

attributeDefinitionId

string

required

The ID for the attribute definition.

Example: 634c26e14cedfd0001775e9e

Query Params

forceCla

boolean

Defaults to false

Controls what the propagation task does with the products it reaches that already have a value
for this attribute:

false = Keep the existing product values and fill in only the empty ones. This is the default when the
parameter is omitted.

true = Overwrite the existing product values with the value of this Category Level Attribute (CLA).

Warning: true replaces values on every product the propagation reaches - the products in this category,
and the products in all of its sub-categories as well once propagation is on for this attribute - including
values entered on individual products by hand, however many products that is. The propagation runs in the
background and cannot be undone: setting the flag back to false only changes later propagations, and
restoring the replaced values means setting them again product by product. Send true only when replacing the
existing product values is what was explicitly asked for.

Body Params

valueIds

array of strings | null

IDs of the dictionary values to select. This is the complete set to keep - values not listed are unselected
and an empty list clears the selection. Every ID must be a value of this attribute definition, and the
definition's limit on the number of selected values applies.

valueIds

Headers

context

string

Specifies the context in which to operate. If omitted, the default context en is used.

In Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.

For more detailed information on how context relates to language settings in Bluestone PIM, refer to the Languages and Context documentation.

Note: The default context is identified by the ID "en". IDs for additional contexts begin with a lowercase "L", not with the digit "1", followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.

Responses

202

Accepted

The request has been accepted for processing, but the processing has not been completed.

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad Request This response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.

404Not Found This response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist.