List filtered dictionary attribute definitions.

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

Retrieve a list of dictionary attribute definitions that match
specified filter criteria. This endpoint allows you to filter dictionary attribute definitions based on various
parameters and return a customized list.

For more detailed information on managing dictionary attributes, refer to our help pages Attribute types -
Dictionary.

Path Params

string

required

Retrieve a list of dictionary attribute definitions filtered by specific criteria by specifying the ID
of the dictionary attribute definition.

Example: 634c26e14cedfd0001775e9f

Body Params

filters

array of objects

List of dictionary value filters.

page

int32

≥ 0

pageSize

int32

1 to 100

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

boolean

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

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-us.bluestonepim.com/pim/definitions/dictionary/id/values/filter/list \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

200OK This response indicates that the request was successful and returns a list of filtered dictionary attribute definitions.

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.