Additional Attributes

How to get extra abitrary data attributes not in the standard representation of the resource with layout lists

The ATS has a concept called layout lists which are predefined table definitions containing arbitrary columns of data attributes linked to the resource in question.

Most resource representations can be expanded by supplying a layout query parameter which should be the ID of an existing layout appropriate to the resource. The extra data will be present under the layout_data key in the returned representation. It will be an array of objects containing the value in the order defined in the layout. The order, column titles, and other meta-data for the requested layout need to be requested seperately via the layout listing endpoint. If value_raw is present this is the Oleeo internal ID for the value.

GET https://api.tal.net/api/v1/applications?layout=123


{
  "id": 47,
  ...
  "layout_data": [
    {
      "value": "Edinburgh",
      "value_raw": 1234
    },
    {
      "value":"1997"
    }
  ],
  ...
},