Container Messages
- Last UpdatedOct 09, 2024
- 1 minute read
A Container can be defined for Types whose classification is dynamic, and provides a stream of data events. Each Container has a unique ID defined by the user.
Immediately after a Type has been registered using a Type message, Containers may be created using that Type. Containers support the same set of actions defined for Type messages: create or update.
The body of a Container message consists of an array of objects with the following keywords:
|
Name |
Value |
|---|---|
|
id |
Unique identifier of the Container. |
|
typeid |
ID of the Type used by the Container. |
|
name |
Optional friendly name for the Container. |
|
description |
Optional description for the Container. |
|
datasource |
Optional string used to specify the source of a stream of data. |
|
tags |
Optional array of strings to tag the Container. |
|
metadata |
Optional key-value pairs associated with the Container. |
|
indexes |
Optional array of Type Property ids to be used as secondary indexes for the Container. |
|
extrapolation |
Optional data mode used to override the extrapolation of a Type definition. Supported values include all, none, forward, and backward. |
|
propertyoverrides |
Optional key-value pairs used to override properties on a Type definition. |
Certain keywords defined on Type properties may be overridden at the container level using the optional propertyoverrides keyword. Currently supported overrides include name, description, uom, minimum, maximum and interpolation. Refer to the Type Properties and Formats for a complete list of Type properties.
If the action header value is delete then only id and typeid are required. All other keywords are ignored.