Entity API

Overview

The entity API is a method to store triple the amount of information. Each entity item is created with an ID, name, type, and app name. Multiple entity items are linked together to form a tree of information. This tree is commonly used to store metadata about an object. For example, if there is a building with several floors and each floor has rooms, you can construct the following entity layout:

  1. Building
    1. Floor 1
      • Room 1
      • Room 2
    2. Floor 2
      • Room 2
      • Room 3
    3. Floor 3
      • Room 4
      • Room 5
      • Room 6

This is a hierarchy structure. The building contains many floors and many rooms. Room 1 belongs to floor 1, room 2 belongs to both floor 1 and floor 2, rooms 4 and 6 belong to floor 3.

IMS Scopes

No scopes required from IMS

Entity Elements

You can have a number of custom properties in Entity. The following fields are mandatory:

Name Schema
id
required		 string
name
required		 string
type
required		 string
appname
required		 string

License information

Terms of service : (C) 2008, 2010-2018 Johnson Controls International Plc. All rights reserved. This software constitutes the trade secrets and confidential and proprietary information of Johnson Controls International Plc. It is intended solely for use by Johnson Controls International Plc. This code may not be copied or redistributed to third parties without prior written authorization from Johnson Controls International Plc.