List filtered dictionary attribute values.

post

https://api-us.bluestonepim.com/pim/definitions/dictionary/{id}/values/list

Lists filtered dictionary attribute values within the given attribute definition ID.

For more detailed information on how to work with the Management API (MAPI) in Bluestone PIM, refer to our help pages Get started with Management API.

Path Params

string

required

The internal ID for the dictionary attribute definition.

Example: 634c26e14cedfd0001775e9f

Query Params

excludeToBeRemoved

boolean

Defaults to false

Body Params

filters

array of objects

Specifies a list of dictionary attribute value filters. This helps in optionally applying multiple filters to narrow down search results when a dictionary have many values.

filters

page

int32

≥ 0

Specifies the number of items to return in each page. The value must be between 1 and 1000.

pageSize

int32

1 to 1000

Specifies the page number for pagination. Default value is 0.

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.

context-fallback

string

Specifies whether to enable the fallback mechanism for the context. If omitted, the default value true will be used. When set to true, the system will provide a default translation or relevant information if the requested context's specific translation is missing.

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

Note: Setting the context-fallback parameter to false disables the fallback mechanism. In this configuration, if a translation or specific context information is not available, the system will not provide an alternative or default content. This ensures that only content that matches the exact context ID requested is returned, potentially leading to cases where no content is available if the specific translation is missing.

Responses

200OK This response indicates that the request was successful and returns a list of filtered dictionary attribute values based on the specified definition ID.

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.