Sign in

v1

latestSwagger 2.02026-07-13137761.0 MB
Asset attribute

Get an attribute of a given asset family

This endpoint allows you to get the information about a given attribute for a given asset family.

get/api/rest/v1/asset-families/{asset_family_code}/attributes/{code}

Path parameters

asset_family_codestring required

Code of the asset family

codestring required

Code of the resource

Response

OK

codestring required

Attribute code

type'text' | 'media_link' | 'number' | 'media_file' | 'single_option' | 'multiple_options' | 'boolean' | 'date' | 'record' required

Attribute type. See <a href='/concepts/asset-manager.html#asset-attribute'>type</a> section for more details.

value_per_localeboolean

Whether the attribute is localizable, i.e. can have one value by locale

value_per_channelboolean

Whether the attribute is scopable, i.e. can have one value by channel

is_required_for_completenessboolean

Whether the attribute should be part of the record's completeness calculation

is_read_onlyboolean

Whether the attribute should be in read only mode only in the UI, but you can still update it with the API

max_charactersinteger

Maximum number of characters allowed for the value of the attribute when the attribute type is text

is_textareaboolean

Whether the UI should display a text area instead of a simple field when the attribute type is text

is_rich_text_editorboolean

Whether the UI should display a rich text editor instead of a simple text area when the attribute type is text

validation_rule'email' | 'url' | 'regexp' | 'none'

Validation rule type used to validate the attribute value when the attribute type is text

validation_regexpstring

Regexp expression used to validate the attribute value when the attribute type is text

allowed_extensionsstring[]

Extensions allowed when the attribute type is media_file

max_file_sizestring

Max file size in MB when the attribute type is media_file

decimals_allowedboolean

Whether decimals are allowed when the attribute type is number

min_valuestring

Minimum value allowed when the attribute type is number

max_valuestring

Maximum value allowed when the attribute type is number

media_type'image' | 'pdf' | 'youtube' | 'vimeo' | 'other' required

For the media_link attribute type, it is the type of the media behind the url, to allow its preview in the PIM. For the media_file attribute type, it is the type of the file.

prefixstring

Prefix of the media_link attribute type. The common url root that prefixes the link to the media

suffixstring

Suffix of the media_link attribute type. The common url suffix for the media

reference_entitystring

Reference entity code for the record attribute type (see <a href='/api-reference-paas-70.html#Referenceentity'>Reference entity</a>).

Example response

{
  "code": "model_is_wearing_size",
  "labels": {
    "en_US": "Model is wearing size",
    "fr_FR": "Le mannequin porte la taille"
  },
  "type": "single_option",
  "value_per_locale": false,
  "value_per_channel": false,
  "is_required_for_completeness": true
}