Up - API Reference - Home
A record is both part of the catalog hierarchy and a collection of fields as specified by its definition.
The catalog hierarchy is defined by an gid-parentgid structure and contains additional metadata such as which channels the record is part of, the ordering, the backlinks.
The metadata also holds the gid of the definition that is used to define the record's fields.
The returned dictionary with records uses the global identifier (gid) as a key.
{
…,
"data": {
"records": {
"f2e64fe0-9ffa-4d9a-8750-d561d6542453": {
"gid": "f2e64fe0-9ffa-4d9a-8750-d561d6542453",
"parent": "04207cb8-425e-4dbf-a00e-28663f6fa951",
"canonical": "f2e64fe0-9ffa-4d9a-8750-d561d6542453",
"backlinks": [],
"treelevel": 4,
"path": [
"f2e64fe0-9ffa-4d9a-8750-d561d6542453",
"04207cb8-425e-4dbf-a00e-28663f6fa951",
"aa16000a-ac3d-412a-a79e-0b1e60ab3ead",
"31754778-c0ae-4c5e-8fab-55a60926c9b6",
"37b69822-c9e4-47f3-9cc1-8d1c14ca2333"
],
"childcount": 5,
"definition": "78273738-5117-4c1e-944a-d1fedabeaca5",
"title": {"nl": "CMS", "en": "CMS"},
"status": "published",
"channels": [
"__all__",
"650ebd0f-eab5-41d7-87c1-1dc5334af872",
"4782d5f5-b62b-4ecb-bf71-5be637a15dc5",
],
"orderings": {
"87b53a4e-359d-45c7-81cb-5e1c3ef444ec": 1,
"f6c547a3-23ec-4e70-92bc-1826ae53570a": 9
},
"is_link": false,
"fields": {
"nl": {
"name": "CMS",
"description": "Mooie serie ijsconservatoren met kunststof schuifdeksels",
"summary": "Kunststof schuifdeksels",
"image": "a04b0100-1918-4152-8c01-9bb7857ab71f",
"images": ["7ab71fbb-1918-4613-8c4a-100785a04b09", "d4cd486e-69da-40d7-b0d2-8905749004f1"],
"brand": "Caravell",
"brand/key": "caravell",
"usps": [
"Regelbare thermostaat achter rooster.",
"Eenvoudig te reinigen door de inwendig ronde hoeken.",
"Met geïntegreerd afvoerpijpje voor lekwater."
],
"properties": [
{"name": "Koeling", "value": "Statisch"},
{"name": "Ontdooiing", "value": "Handmatig"},
{"name": "Isolatie (mm)", "value": "60"},
{"name": "Temperatuurbereik (ºC)", "value": "-24/-14"},
{"name": "Omgevingstemperatuur (ºC)", "value": "30"},
{"name": "Rel. luchtvochtigheid (%)", "value": "55"},
{"name": "Materiaal uitwendig", "value": "Plaatstaal met witte poedercoating"},
{"name": "Materiaal inwendig", "value": "Aluminium"},
{"name": "Koelmiddel", "value": "R134A"}
],
"footnote": "Voor opties/accessoires <X\\acccms#0>",
"downloads": [
"b42c0898-ce9c-422a-aa2e-fe8e4e17c693",
"efc024b2-e639-4dc8-8759-3902081a3690",
],
"crossrefs": [
"4198c6be-ccba-4662-8e88-33e33a2180dd",
"edfdb3cd-4605-4396-9a13-b4879008c768",
"8ca19d57-2ef2-488e-87c8-598fa1a17d45",
],
"movies": [
{
"url":"http://www.youtube.com/watch?v=4HK4-qEuIhM",
"name":"Caravell Bedrijfspresentatie",
"preview":"78306cad-7774-40ca-bda4-bdbe0ca7f70c"
},
],
"meta_title": null,
"meta_description": null,
"keywords": "CMS",
"search_phrases": null,
"boost": 1
},
"en": {
"name": "CMS",
"description": "Nice series of ice conservators with hard plastic sliding covers",
"summary": "Hard plastic sliding covers",
"image": "-jQ4HMph-XZf1ZauPJ53I",
"images": ["7ab71fbb-1918-4152-8c01-100785a04b09", "d4cd486e-69da-40d7-b0d2-8905749004f1"],
"brand": "Caravell",
"brand/key": "caravell",
"usps": [
"Adjustable thermostat behind grille.",
"Easily cleaned because of the rounded internal corners.",
"Integrated drainage for condensation water."
],
"properties": [
{"name": "Cooling", "value": "Static"},
{"name": "Defrosting", "value": "Manual"},
{"name": "Isolation (mm)", "value": "60"},
{"name": "Temperature range (ºC)", "value": "-24/-14"},
{"name": "Ambient temperature (ºC)", "value": "30"},
{"name": "Rel. humidity (%)", "value": "55"},
{"name": "Material exterior", "value": "Steel plate with white powder coat"},
{"name": "Material interior", "value": "Aluminum"},
{"name": "Coolant", "value": "R134A"}
],
"footnote": "For options/accessories <X\\acccms#0>",
"downloads": [
"b42c0898-ce9c-422a-aa2e-fe8e4e17c693",
"efc024b2-e639-4dc8-8759-3902081a3690",
],
"crossrefs": [
"4198c6be-ccba-4662-8e88-33e33a2180dd",
"edfdb3cd-4605-4396-9a13-b4879008c768",
"8ca19d57-2ef2-488e-87c8-598fa1a17d45",
],
"movies": [
{
"url":"http://www.youtube.com/watch?v=4HK4-qEuIhM",
"name":"Caravell Brand Presentation",
"preview":"78306cad-7774-40ca-bda4-bdbe0ca7f70c"
},
],
"meta_title": null,
"meta_description": null,
"keywords": null,
"search_phrases": null,
"boost": 1
},
},
}
}
}
}
gid global identifier
parent identifier for parent record
canonical linked records all share the same canonical
backlinks are gids from records with this record as the canonical
treelevel starting from 0, how many levels from the root
path list of gids that make up the route from the root up to and including the current record, in reverse order (current record first, root last)
childcount the number of children (possibly 0) for this record
definition the definition's gid - this defines which fields follow
title the title is used to represent a record in e.g. the treeview or search results - it is a value from one of the fields, as specified in the definition - it is always available in all requested languages
status used to track delete/undelete/permanent delete functionality
channels all project channels that include this record
orderings a numeric value indicating relative position to its siblings, for all the orderings defined in the project
is_link indicates if this is a linked record, if so, then canonical points to the main record
fields a dictionary of dictionaries of field values, with the field names as keys - the definition knows the type, options, and validations for all these fields - the top-level dictionary holds the language-code(s) that were requested - for fields that have a list of values defined in the options, an extra key is inserted with the field name and /key appended, like brand/key in the example above
A \n value in a field or property indicates a newline character.