Entities are used as containers for other property, entity, and action objects that create the API hierarchy. The following table describes the entity JSON object format:

"<entity name>": {
  "short_description": <string>,
  "collection": <string enum>,
  "key_property": <string>,
  "dynamic_support": <boolean>,
  "properties": {
    "property1": <property object>,
    "propertyN": <property object>
  },
  "entities": {
    "entity1": <entity object>,
    "entityN": <entity object>
  },
  "actions": {
    "action1": <entity object>,
    "actionN": <entity object>
  },
  "operations: {
    "get": {},
    "set": {
      "fields": {
        "optional": <array of fields>
      }
    },
    "add": {
      "roles": <array of roles>,
      "fields": {
        "required": <array of fields>,
        "optional": <array of fields>
      }
    },
    "remove": {
    "roles": <array of roles>
    }
  }
}

JSON object/property	Description
`short_description=<string>`	A short entity description.
`collection=<string enum>`	Specifies if the entity is a singleton or a collection entity. The value is set to "singleton" for singleton and "map" for collection entities.
`key_property=<boolean>`	Specifies the key property that is only available for collection entities. The value contains the name of the property within the entity used to identify the items in the collection.
`dynamic_support=<boolean>`	Specifies if the entity is dynamically supported. If `true`, there will be another runtime meta property indicating if the entity is supported. The name of the meta property is `{entity name}_supported`. If the meta property is `false` the entity value will be `null`.
`properties`	Contains properties belonging to the entity.
`properties.<NAME>`	Each property of the entity is defined as a separate object. The structure of a property definition is explained below.
`actions`	Contains actions belonging to the entity.
`actions.<NAME>`	Each action of the entity is defined as a separate object. The structure of an action definition is explained below.
`entities`	This object contains sub-entities belonging to the entity.
`entities.<NAME>`	Each sub-entity is defined as a separate object. The structure of an entity definition is explained in this table.
`operations`	Specifies the operations that can be performed on the entity/entity collection.
`operations.get`	Specifies if the entity is gettable. If an entity has gettable properties/entities, the entity itself will become gettable.
`operations.set`	Specifies if the entity is settable.
`operations.set.fields.optional`	List of fields that can be used when setting the entity.
`operations.add`	Specifies if entities can be added to an entity collection. This operation is only available for collection entities.
`operations.add.roles`	List of roles that can perform the add operation.
`operations.add.fields.optional`	List of optional fields that can be used when adding an entity to a collection.
`operations.add.fields.required`	List of required fields that must be provided when adding an entity to a collection.
`operations.remove`	Specifies if entities can be deleted from an entity collection. This operation is only available for collection entities.
`operations.remove.roles`	List of roles that can perform the remove operation.

Date	Description
2024–06–10	VAPIX® Device configuration is released Device Configuration APIs: New API

Introduction

Version history