Get a record of a given reference entity

GET

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

Reference entity record

This endpoint allows you to get the information about a given record for a given reference entity.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/rest/v1/reference-entities//records/'

Response Example

200 - Example 1

{
  "code": "kartell",
  "created": "2023-08-15T05:53:50.719Z",
  "updated": "2023-08-15T05:53:50.719Z",
  "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"
      }
    ]
  }
}

Request

Path Params

reference_entity_code

string

required

Code of the reference entity

code

string

required

Code of the resource

Responses

🟢200OK

application/json

Body

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

🟠401Authentication required

🟠404Resource not found

🟠406Not Acceptable

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

Update/create several reference entity records

Update/create a record of a given reference entity