Future points

PI Web API can create OMF PI Points with future data support using the metadata property in an OMF container message. 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.

Note: The future designation applies to all properties in the container.

For example:

[

{

"id": "PredictedEnergyCost",

"typeid": "TimeIndexed.Single",

"datasource":"ADH",

"metadata": {

"future": true

}

}

]

Since future attributes of PI Points cannot be changed, the future property attribute applies only during CREATE operations. When creating a new PI Point, future data support is enabled. If you attempt to create a PI Point and the PI Point already exists, PI Web API will not make any changes but instead returns a success status with a "PI Point already exists" warning message.

When updating container messages:

• If the PI Point does not exist, then the update process creates the new PI point and enables future data support.

• If the existing PI Point's future data setting matches the existing container, the future metadata ignores the new message.

• If the status of the metadata item is future=true and the update message specifies future=false, the system returns a success status with a "future metadata was ignored" warning message.

• If the status of the metadata item is future=false and the update message specifies future=true, the system returns an error status (409 conflict) message.

• If multiple CONTAINER/OMF PI points are in the container message, the CONTAINER/OMF PI points without conflict will process correctly. CONTAINER/OMF PI points with conflicts will produce the appropriate response based on the situation.