Akeneo PIM REST API
  1. Reference entity attribute
Akeneo PIM REST API
  • Authentication
    • Get authentication token
      POST
  • Overview
    • Get list of all endpoints
      GET
  • PAM asset category
    • Get list of PAM asset categories
      GET
    • Update/create several PAM asset categories
      PATCH
    • Create a new PAM asset category
      POST
    • Get a PAM asset category
      GET
    • Update/create a PAM asset category
      PATCH
  • Asset family
    • Get list of asset families
      GET
    • Get an asset family
      GET
    • Update/create an asset family
      PATCH
  • Asset
    • Get the list of the assets of a given asset family
      GET
    • Update/create several assets
      PATCH
    • Delete an asset
      DELETE
    • Get an asset of a given asset family
      GET
    • Update/create an asset
      PATCH
  • Asset attribute
    • Get the list of attributes of a given asset family
      GET
    • Get an attribute of a given asset family
      GET
    • Update/create an attribute of a given asset family
      PATCH
  • Asset attribute option
    • Get a list of attribute options of a given attribute for a given asset family
      GET
    • Get an attribute option for a given attribute of a given asset family
      GET
    • Update/create an asset attribute option for a given asset family
      PATCH
  • Asset media file
    • Create a new media file for an asset
    • Download the media file associated to an asset
  • PAM asset tag
    • Get list of PAM asset tags
    • Get a PAM asset tag
    • Update/create a PAM asset tag
  • PAM asset
    • Get list of PAM assets
    • Update/create several PAM assets
    • Create a new PAM asset
    • Get a PAM asset
    • Update/create a PAM asset
  • PAM asset reference file
    • Get a reference file
    • Upload a new reference file
    • Download a reference file
  • PAM asset variation file
    • Get a variation file
    • Upload a new variation file
    • Download a variation file
  • Association type
    • Get a list of association types
    • Update/create several association types
    • Create a new association type
    • Get an association type
    • Update/create an association type
  • Attribute group
    • Get list of attribute groups
    • Update/create several attribute groups
    • Create a new attribute group
    • Get an attribute group
    • Update/create an attribute group
  • Attribute
    • Get list of attributes
    • Update/create several attributes
    • Create a new attribute
    • Get an attribute
    • Update/create an attribute
  • Attribute option
    • Get list of attribute options
    • Update/create several attribute options
    • Create a new attribute option
    • Get an attribute option
    • Update/create an attribute option
  • Category
    • Get list of categories
    • Update/create several categories
    • Create a new category
    • Get a category
    • Update/create a category
    • Download a category media file [COMING SOON]
  • Channel
    • Get a list of channels
    • Update/create several channels
    • Create a new channel
    • Get a channel
    • Update/create a channel
  • Currency
    • Get a list of currencies
    • Get a currency
  • Family
    • Get list of families
    • Update/create several families
    • Create a new family
    • Get a family
    • Update/create a family
    • Create a new family variant
  • Family variant
    • Get list of family variants
    • Update/create several family variants
    • Get a family variant
    • Update/create a family variant
  • Locale
    • Get a list of locales
    • Get a locale
  • Measure family
    • Get list of measure familiy
    • Get a measure family
  • Measurement family
    • Get list of measurement families
    • Update/create several measurement families
  • Product media file
    • Get a list of product media files
    • Create a new product media file
    • Get a product media file
    • Download a product media file
  • Product model
    • Get list of product models
    • Update/create several product models
    • Create a new product model
    • Delete a product model
    • Get a product model
    • Update/create a product model
    • Get a draft
    • Submit a draft for approval
  • Product
    • Get list of products
    • Update/create several products
    • Create a new product
    • Delete a product
    • Get a product
    • Update/create a product
    • Get a draft
    • Submit a draft for approval
  • Published product
    • Get list of published products
    • Get a published product
  • Reference entity
    • Get list of reference entities
    • Get a reference entity
    • Update/create a reference entity
  • Reference entity media file
    • Create a new media file for a reference entity or a record
    • Download the media file associated to a reference entity or a record
  • Reference entity attribute
    • Get the list of attributes of a given reference entity
      GET
    • Get an attribute of a given reference entity
      GET
    • Update/create an attribute of a given reference entity
      PATCH
  • Reference entity attribute option
    • Get a list of attribute options of a given attribute for a given reference entity
    • Get an attribute option for a given attribute of a given reference entity
    • Update/create a reference entity attribute option
  • Reference entity record
    • Get the list of the records of a reference entity
    • Update/create several reference entity records
    • Get a record of a given reference entity
    • Update/create a record of a given reference entity
  • System
    • Get system information
    • Get system information
  • Catalogs
    • Get the list of owned catalogs
    • Create a new catalog
    • Delete a catalog
    • Get a catalog
    • Update a catalog
  • Catalog products
    • Get the list of product uuids
    • Get the list of products related to a catalog
    • Get a product related to a catalog
  • Product [identifier]
    • Get list of products
    • Update/create several products
    • Create a new product
    • Delete a product
    • Get a product
    • Update/create a product
    • Get a draft
    • Submit a draft for approval
  • Product [uuid]
    • Get list of products
    • Update/create several products
    • Create a new product
    • Delete a product
    • Get a product
    • Update/create a product
    • Get a draft
    • Submit a draft for approval
  1. Reference entity attribute

Update/create an attribute of a given reference entity

PATCH
/api/rest/v1/reference-entities/{reference_entity_code}/attributes/{code}
This endpoint allows you to update a given attribute for a given renference entity. Note that if the attribute does not already exist for the given reference entity, it creates it.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH '/api/rest/v1/reference-entities//attributes/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "code": "description",
    "is_required_for_completeness": true,
    "is_rich_text_editor": true,
    "is_textarea": true,
    "labels": {
        "en_US": "Description",
        "fr_FR": "Description"
    },
    "max_characters": null,
    "type": "text",
    "validation_regexp": null,
    "validation_rule": "none",
    "value_per_channel": false,
    "value_per_locale": true
}'
Response Response Example
201 - Example 1
{}

Request

Path Params
reference_entity_code
string 
required
Code of the reference entity
code
string 
required
Code of the resource
Body Params application/json
allowed_extensions
array[string]
optional
Extensions allowed when the attribute type is image
code
string 
required
Attribute code
decimals_allowed
boolean 
optional
Whether decimals are allowed when the attribute type is number
Default:
false
is_required_for_completeness
boolean 
optional
Whether the attribute should be part of the record's completeness calculation
Default:
false
is_rich_text_editor
boolean 
optional
Whether the UI should display a rich text editor instead of a simple text area when the attribute type is text
is_textarea
boolean 
optional
Whether the UI should display a text area instead of a simple field when the attribute type is text
Default:
false
labels
object 
optional
Attribute labels for each locale
Default:
{}
localeCode
string 
optional
Attribute label for the locale localeCode
max_characters
integer 
optional
Maximum number of characters allowed for the value of the attribute when the attribute type is text
max_file_size
string 
optional
Max file size in MB when the attribute type is image
Default:
null
max_value
string 
optional
Maximum value allowed when the attribute type is number
Default:
null
min_value
string 
optional
Minimum value allowed when the attribute type is number
Default:
null
reference_entity_code
string 
optional
Code of the linked reference entity when the attribute type is reference_entity_single_link or reference_entity_multiple_links
Default:
null
type
enum<string> 
required
Attribute type. See type section for more details.
Allowed values:
textimagenumbersingle_optionmultiple_optionsreference_entity_single_linkreference_entity_multiple_links
validation_regexp
string 
optional
Regexp expression used to validate the attribute value when the attribute type is text
Default:
null
validation_rule
enum<string> 
optional
Validation rule type used to validate the attribute value when the attribute type is text
Allowed values:
emailurlregexpnone
Default:
none
value_per_channel
boolean 
optional
Whether the attribute is scopable, i.e. can have one value by channel
Default:
false
value_per_locale
boolean 
optional
Whether the attribute is localizable, i.e. can have one value by locale
Default:
false
Examples

Responses

🟢201Created
application/json
Body
object {0}
🟢204No content to return
🟠401Authentication required
🟠415Unsupported Media type
🟠422Unprocessable entity
Modified at 2023-08-15 05:53:55
Previous
Get an attribute of a given reference entity
Next
Get a list of attribute options of a given attribute for a given reference entity
Built with