Get Reference Entity Record By Code

Get a record of a given reference entity

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

Use it in a workflow

Add a step and choose the Akeneo connector.
Pick the Get Reference Entity Record By Code action (under Reference entity record).
Fill in the fields below, then reference the result from later steps as {{getReferenceEntityRecordByCode.response.data}}.

Request

Path parameters

reference_entity_codestringrequired

This path parameter is used to specify the unique identifier of the reference entity you want to retrieve or manipulate. It is essential for identifying the specific reference entity in the API requests. Ensure that the reference entity code is correctly formatted and corresponds to an existing reference entity in the system.

codestringrequired

This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate. It is essential for identifying the specific entity in the API requests. Ensure that the code is correctly formatted and corresponds to an existing entity in the system.

Response

Returns 200 with an object. Read it in later steps with {{getReferenceEntityRecordByCode.response.data.<field>}}.

codestring

Code of the record

valuesobject

Record attribute values

createdstring | null

updatedstring | null

json

{
  "code": "kartell",
  "values": {
    "label": [
      {
        "locale": "en_US",
        "channel": null,
        "data": "Kartell"
      }
    ],
    "image": [
      {
        "locale": null,
        "channel": null,
        "data": "0/c/b/0/0cb0c0e115dedba676f8d1ad8343ec207ab54c7b_image.jpg"
      }
    ],
    "description": [
      {
        "locale": "en_US",
        "channel": null,
        "data": "Kartell, the Italian furniture company that sells modern and remarkable pieces of furniture."
      },
      {
        "locale": "fr_FR",
        "channel": null,
        "data": "Kartell, l'éditeur de meuble italien spécialisé dans la signature de belles pièces au design contemporain."
      }
    ],
    "country": [
      {
        "locale": null,
        "channel": null,
        "data": "italy"
      }
    ],
    "creation_year": [
      {
        "locale": null,
        "channel": null,
        "data": "1949"
      }
    ]
  },
  "created": "2021-01-01T01:23:34+00:00",
  "updated": "2021-02-03T23:45:59+00:00"
}

Need more? See the Akeneo guide for connection setup and behaviour shared by every action.

Was this page helpful?