Create new relation definition.

post

https://api-us.bluestonepim.com/pim/relations

Create a new relation definition. The ID for the new relation definition is generated by Bluestone PIM and included in the response headers under resource-id.

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

Body Params

description

string

direction

string

name

string

required

length ≥ 1

number

string

quantityEnabled

boolean

reverseName

string

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

201

Created

The new ID is included in the response headers under resource-id.

See the example below:

resource-id: 664cc80da825236207fe01a9

201Created The new ID is included in the response headers under resource-id. See the example below: resource-id: 664cc80da825236207fe01a9

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.

409Conflict This response indicates that the request could not be completed due to a conflict with the current state of the target resource. This typically occurs when there are duplicate entries or other data conflicts.