Search attribute definitions by a filter and return the matching ones as a paged list.

post

https://api-us.bluestonepim.com/pim/definitions/list

Each filter in the
request body selects definitions whose number matches one of the given values (NUMBER_IN) or whose ID matches
one of the given values (ID_IN); an empty or omitted filter list returns all definitions. Use this to look up
specific definitions by known numbers or IDs; to page through every definition without a filter, use the plain
list endpoint instead.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

excludeToBeRemoved

boolean

Defaults to false

When true, definitions that are marked for removal (an async delete is in progress)
are omitted from the result. Defaults to false, which keeps them.

Body Params

filters

array of objects | null

Specifies the list of attribute definition filters. This field is used for filtering attribute definitions based
on various criteria.

filters

page

int32

≥ 0

The number of items to return in each block. If omitted, the default value 1000 will be used. This parameter
works with the page parameter to paginate the result set, allowing you to control the size of each page of
results. The value must be between 1 and 1000.

Default value: 1000

pageSize

int32

1 to 1000

A number sequence representing a block of items to return as a result set. If omitted, the default value 0
will be used. This parameter is used for pagination to specify which page of the results to retrieve.

Default value: 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

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

Loading…

Response

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