Keywords for type messages

ID

String

Required

Yes

Becomes the element template name. 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 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.

classification

String

Required

Partially

Stored as an extended property on the element template.

type

String

Required

Partially

Inherited from JSON schema. Must be set to object.

properties

Object

Required

Partially

Stored as attribute templates on the element template.

For complete details about this keyword, see Example properties keyword for type messages.

name

String

Optional

Yes

Stored in the description of the element template in the format of NAME\VERSION\DESCRIPTION.

description

String

Optional

Yes

Stored in the description of the element template in the format of NAME\VERSION\DESCRIPTION.

The description property is exempt from reserved characters; any character can be used.

version

String

Optional

Yes

Stored in the description of the element template in the format of NAME\VERSION\DESCRIPTION. Version of the type. If omitted version 1.0.0.0 is assumed.

tags

Array

Optional

Yes

Stored as categories on the template. If a tag specified in a type message does not exist in PI AF as a category, it will be created and then added to the element template.

metadata

Object

Optional

Yes

Stored as an extended property on the element template.

Note: To use PI quality definition, set the metadata property "DataQualitySchema" to PI.

enum

Array

Optional

Yes

Cannot be used in conjunction with:

• classification

• properties

• tags

• metadata

  Name/value pairs used to define an allowed set of values.

  For complete details about the contents of this array, see the Enum Type Message topic.

extrapolation

String

Optional

Yes

Stored as an extended property on the element template. Supported values are:

• all

• none

• forward

• backward

  The value of this keyword is only stored and is not used by the PI System.