Update attribute definition metadata.

patch

https://api.test.bluestonepim.com/pim/definitions/{id}

This endpoint allows you to modify the name and other metadata of the
attribute definition within the specified context.

It applies to attribute definitions of every type (simple, dictionary, matrix, column and compound), and it is
the endpoint for updating the context-aware description, which the type-specific PUT endpoints do not
change. This is a partial update: only the fields present in the request are changed.

Example: Update the description in the context given by the context header:

{
  "description": {
    "value": "New description"
  }
}

For more detailed information on how to work with attribute definitions in Bluestone PIM, refer to the Create,
edit or remove attributes article.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The internal ID for the attribute definition you want to update.

Example: 634c26e14cedfd0001775e9f

Query Params

validation

string

enum

Defaults to NAME

Validation strategy for the update operation. Can be either NAME or NONE and defaults to
NAME.

NAME means that a validation check will be performed to make sure that no other attribute definition exist
with the same name.

NONE can be used to create an attribute definition with the same name as an other existing attribute
definition. Note: The number must always be unique.

Allowed:

Body Params

description

object | null

externalSource

boolean | null

Specifies whether the origin of the attribute is managed in an external source like ERP systems and hence should
be read-only for the editors in the Bluestone PIM UI. Note that the value still can be modified via the
Management API.

internal

boolean | null

Indicates that the attribute is for internal use only within Bluestone PIM, meaning this value is not visible in
the Public API (PAPI) or accessible outside the system; for example, attributes for system configuration or
internal categorization.

name

object | null

number

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

204

No Content

This response status indicates that the request was successfully processed and there is no content to
return.

Language

Credentials

OAuth2

Loading…

Response

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

application/json

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.