Create a new simple attribute definition.

post

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

Creates a basic (single-value) attribute definition and returns its generated ID in the resource-id response
header (for example 664cc80da825236207fe01a7). This endpoint handles simple attributes only — use the
type-specific endpoints for other kinds: /definitions/column, /definitions/matrix, /definitions/dictionary
and /compoundDefinitions. A name is required. Fails if number is not unique, if validation is NAME and
another definition already has the same name, if a referenced attribute group does not exist, or if the
attribute-definition quota is exceeded.

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
and Attribute types.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

validation

string

enum

Defaults to NAME

NAME (the default) rejects the request if another attribute definition already has the same
name; NONE allows a duplicate name. The number must always be unique regardless of this setting.

Allowed:

Body Params

charset

string | null

contentType

string | null

contextAware

boolean | null

dataType

string | null

enum

description

string | null

externalSource

boolean | null

groupId

string | null

internal

boolean | null

name

string | null

number

string | null

restrictions

object | null

unit

string | null

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

201Created

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.

404Not Found This response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist.

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.