Types can be created, updated, or deleted. Updating a Type without updating the Type’s version will result in failure. Once a Type is deleted, any operations on Containers or Data using that Type will fail.
The body of a Type message consists of an array of objects. The following keywords are used to define a Type:
||Unique identifier of the Type.|
||Optional version of the Type. If omitted version 22.214.171.124 is assumed.|
||Optional friendly name for the Type.|
||Optional description for the Type.|
||Optional array of strings to tag the Type.|
||Optional key-value pairs associated with the Type.|
||Key-value pairs defining the properties of the Type.|
||Inherited from JSON Schema. Must be set to
id cannot begin with the character sequence __. This is reserved for predefined Types. One currently supported predefined Type is __Link.
static classification represents metadata describing a device being observed and should be used to capture data that is descriptive and relatively unchanging. A
dynamic classification represents observed or calculated measurements taken from a device.
At least one property must be designated as the index by supplying the
isindex keyword with a value of
true. The designated
isindex property is used to uniquely identify discrete Data objects so that they can be updated or deleted after their initial creation. For a compound index, the order of index properties within the message determines the order within the index.
One property may be optionally designated as the name by supplying the
isname keyword with a value of
true. Because the
isindex must be unique across all assets, the name keyword allows for multiple distinct Data objects to share a common name.
Each property may have an optional friendly name and description specified by the
description keywords respectively with a string value.