Filter relation definitions.

post

https://api.bluestonepim.com/pim/relations/list

Filter relation definitions based on specified criteria. This endpoint allows you to retrieve a list of relation definitions that match the given filters.

Note: For a relation definitions to be found it needs to map to at least one of the values in each object in the filters array.

Example: Imagine if we have these two relation definitions:

Relation definition: Contains

Number: contains-relation
ID: 64ef9336bec72f3271090e97

Relation definition: Spare part of

Number: spare-part-of-relation
ID: 64ef9336bec72f3271090e98

And then we filter on the criteria's below. Then only the relation definition Contains will be found since it maps to one of the values in both the NUMBER_IN and ID_IN objects. The relation definition Spare part of will not be found since it only maps to a value in the NUMBER_IN object but not to any value in the ID_IN object:

  "filters": [
    {
      "type": "NUMBER_IN",
      "values": [
        "contains-relation",
        "spare-part-of-relation"
      ]
    },
    {
      "type": "ID_IN",
      "values": [
        "64ef9336bec72f3271090e97",
        "111111111111111111111111"
      ]
    }
  ]

For more detailed information on how to work with relation definitions in Bluestone PIM, refer to our help pages The data model > Relations.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

filters

array of objects

Filters by which relations are searched.

page

int32

≥ 0

pageSize

int32

1 to 1000

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