Data message keywords

typeid

String

Optional

Yes

ID of a type created from a static type message. The message should include either typeid or containerid.

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

When deleting a Type, it is not necessary to provide full entity definitions. ID is the only required keyword. 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.

containerid

String

Optional

Yes

ID of the container created from dynamic type. The message should include either containerid or typeid. If the containerid is included, the values should be defined according to the container's dynamic type.

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

When deleting a Container, 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.

properties

Object

Optional

Partially

Optional key-value pairs defining any non-type-derived properties included in the values. Used to send typeless static data, or to extend the type specified by typeid with additional properties.

Currently, the PI Web API requires that all static data uses a type. For example, typeid must be included in the message when specifying properties.

values

Array

Required

Yes

Array of data value objects. Each object represents a separate data value, and specifies the value for all properties on the type or container.

The OMF specification includes some built-in types, such as the link type. For more information, review the Link data messages.