Container message keywords

ID

String

Required

Yes

Unique identifier of the container. The name of any PI point is always derived from the id.

For simple containers the PI points will be named $"{container.id}".

For complex containers the PI points will be named $"{container.id}.{property.index}".

After the Container ID is defined, it can be referred to case insensitively. For example, when creating a new instance of the container.

Note: When deleting Container data, it is not necessary to provide full entity definitions. ID and typeID are the only required keywords. The system ignores any additional information provided in the DELETE message.

For complete details about the simplified handling of Delete messages, see Simplified Delete Option.

typeID

String

Required

Yes

ID of the dynamic type used by the container. After the Type ID is defined, it can be referred to case insensitively. For example, when creating a new instance of the Type.

Note: When deleting Container data, it is not necessary to provide full entity definitions. ID and typeID are the only required keywords. The system ignores any additional information provided in the DELETE message.

For complete details about the simplified handling of Delete messages, see Simplified Delete Option.

name

String

Optional

Yes

Used as part of the name of any AF Attributes created by a static-to-dynamic link message. For example, if the name is WidgetOne, AF Attributes will be named like WidgetOne or WidgetOne.XXX (where XXX is the name of the type property).

description

String

Optional

Yes

Description of any PI points the container represents.

datasource

String

Optional

Yes

Used to specify the source of a stream of data. The Point Source of any PI points is controlled by this keyword. If omitted, PI Web API will use the default Point Source PIWebAPI_OMF.

tags

Array

Optional

No

If included, this property is ignored.

metadata

Object

Optional

Yes

Used for the creation of future data. A container message that consists of a metadata property with the key future and a Boolean value of true results in a future attribute set for the PI Point.

indexes

Array

Optional

No

If included, this property is ignored.

extrapolation

String

Optional

Partially

Overrides the extrapolation mode defined by the dynamic type. This information is stored by the PI Web API, but it has no impact on data queries.

propertyoverrides

Object

Optional

Yes

Overrides keywords defined on properties of the dynamic type.