Update/create a reference entity attribute option

PATCH

/api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options/{code}

Reference entity attribute option

This endpoint allows you to update a given option for a given attribute and a given reference entity. Learn more about Update behavior. Note that if the option does not already exist for the given attribute of the given reference entity, it creates it.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/rest/v1/reference-entities//attributes//options/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "code": "global_nomad",
    "labels": {
        "en_US": "Global Nomad",
        "fr_FR": "Nomade du Monde"
    }
}'

Response Example

201 - Example 1

{}

Request

Path Params

reference_entity_code

string

required

Code of the reference entity

attribute_code

string

required

Code of the attribute

code

string

required

Code of the resource

Body Params application/json

code

string

required

Attribute's option code

labels

object

optional

Attribute labels for each locale

Default:

{}

localeCode

string

optional

Attribute label for the locale localeCode

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

Get an attribute option for a given attribute of a given reference entity

Get the list of the records of a reference entity