Template hierarchy responses

Overview

This page explains the fields that are returned when you make a request to Retrieve the template hierarchy.

A client application will typically use this information to find out the screens that it needs to display and how they relate to each other.

Example response

A template hierarchy response looks like this.

Note that only two top-level children are included to save space.

JSON

{
  "templates": [
    {
      "id": "ac46dd30-4273-4679-84e8-5d00b21ab802",
      "tenant": "OPERATOR1",
      "name": "OPERATOR1-OpenDevices",
      "title": null,
      "properties": {
        "menuPosition": "vertical"
      },
      "children": [
        {
          "id": "c334fa74-efaf-40e2-81e1-99bad86f59d9",
          "tenant": "OPERATOR1",
          "name": "OPERATOR1-OD-HOME",
          "title": "HOME",
          "properties": {
            "screenId": "1",
            "icon": "icon_menu_home_focused",
            "routeName": "discover"
          },
          "children": []
        },
        {
          "id": "6a1e6000-8cbb-4905-a45b-33ed2ec19a85",
          "tenant": "OPERATOR1",
          "name": "OPERATOR1-OD-MOVIES",
          "title": "MOVIES",
          "properties": {
            "screenId": "1000",
            "icon": "icon_menu_movies"
          },
          "children": []
        },
        ...
      ]
    }
  ]
}

Fields

The response includes a single templates block containing an array of objects, each of which includes the fields in the following table:

Field	Description
`id`	The template ID
`tenant`	The tenant ID This is used in shared system deployments to filter templates so that each sub-tenant’s client applications only receive their own templates.
`name`	The template name
`title`	The template title
`properties`	Additional properties that have been set for the layout (That is, for the version of the template that is appropriate for the client, based on device type, etc.) Such properties may be used, for example, to tell the client that a particular template/page should be styled in a particular way.
`children`	Any child templates Each child template has exactly the same fields as its parent and can also contain `children`.