Update/create a record of a given reference entity

PATCH

/api/rest/v1/reference-entities/{reference_entity_code}/records/{code}

Reference entity record

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

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/rest/v1/reference-entities//records/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "code": "kartell",
    "values": {
        "collection_overview": [
            {
                "channel": null,
                "data": "5/1/d/8/51d81dc778ba1501a8f998f3ab5797569f3b9e25_img.png",
                "locale": null
            }
        ],
        "country": [
            {
                "channel": null,
                "data": "italy",
                "locale": null
            }
        ],
        "creation_year": [
            {
                "channel": null,
                "data": "1949",
                "locale": null
            }
        ],
        "description": [
            {
                "channel": null,
                "data": "Kartell, the Italian furniture company that sells modern and remarkable pieces of furnitures.",
                "locale": "en_US"
            },
            {
                "channel": null,
                "data": "Kartell, l'\''éditeur de meuble italien spécialisé dans la signature de belle pièces au design contemporain.",
                "locale": "fr_FR"
            }
        ],
        "image": [
            {
                "channel": null,
                "data": "0/c/b/0/0cb0c0e115dedba676f8d1ad8343ec207ab54c7b_image.jpg",
                "locale": null
            }
        ],
        "label": [
            {
                "channel": null,
                "data": "Kartell",
                "locale": "en_US"
            }
        ]
    }
}'

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

code

string

required

Code of the record

created

string <dateTime>

optional

Date of creation.

Default:

null

updated

string <dateTime>

optional

Date of the last update.

Default:

null

values

object

optional

Record attributes values, see Reference entity record values section for more details

attributeCode

array [object {3}]

optional

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 a record of a given reference entity

Get system information