Update/create several reference entity records

PATCH

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

Reference entity record

This endpoint allows you to update and/or create several records of one given reference entity at once. 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"
                }
            ]
        }
    },
    {
        "code": "ligneroset",
        "values": {
            "country": [
                {
                    "channel": null,
                    "data": "france",
                    "locale": null
                }
            ],
            "creation_year": [
                {
                    "channel": null,
                    "data": "1860",
                    "locale": null
                }
            ],
            "description": [
                {
                    "channel": null,
                    "data": "Very well known French brand of modern and luxury furniture",
                    "locale": "en_US"
                },
                {
                    "channel": null,
                    "data": "La marque renommée des meubles de luxe à la française",
                    "locale": "fr_FR"
                }
            ],
            "image": [
                {
                    "channel": null,
                    "data": "4/b/0/1/0cb0c0e115dedde78b8d1ad8343ec980cd5daa54_image.jpg",
                    "locale": null
                }
            ],
            "label": [
                {
                    "channel": null,
                    "data": "Ligne Roset",
                    "locale": "en_US"
                }
            ]
        }
    },
    {
        "code": "usm",
        "values": {
            "country": [
                {
                    "channel": null,
                    "data": "switzerland",
                    "locale": null
                }
            ],
            "creation_year": [
                {
                    "channel": null,
                    "data": "1885",
                    "locale": null
                }
            ],
            "description": [
                {
                    "channel": null,
                    "data": "Modular furniture from Switzerland for your home and office",
                    "locale": "en_US"
                },
                {
                    "channel": null,
                    "data": "L'\''éditeur de meubles modulaires suisse pour votre intérieur et pour les entreprises",
                    "locale": "fr_FR"
                }
            ],
            "image": [
                {
                    "channel": null,
                    "data": "9/c/g/1/0cb0c0e115dedba76f8d1ad8343ec897abc43bv4_image.jpg",
                    "locale": null
                }
            ],
            "label": [
                {
                    "channel": null,
                    "data": "USM",
                    "locale": "en_US"
                }
            ]
        }
    }
]'

Response Example

200 - Example 1

[
  {
    "code": "string",
    "message": "string",
    "status_code": 0
  }
]

Request

Path Params

reference_entity_code

string

required

Code of the reference entity

Body Params application/json

array of:

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

🟢200OK

application/json

Body

array of:

code

string

optional

Resource code

message

string

optional

Message explaining the error

status_code

integer

optional

HTTP status code, see Client errors to understand the meaning of each code

🟠401Authentication required

🟠413Request Entity Too Large

🟠415Unsupported Media type

Modified at 2023-08-15 05:53:55

Get the list of the records of a reference entity

Get a record of a given reference entity