Responses to OMF messages

When you send an OMF message to the PI Web API OMF endpoint, PI Web API may respond on a per-request or per-message basis. The response contains information related to the execution of the request or messages. For example, the returned information can indicate:

• Whether the message was properly constructed

• Whether the message was received by the PI System

• Whether an error occurred

It is very important that you understand the content of the responses. If there are problems with the messages created by your application, you can review the responses to determine the problems and resolve them.

Responses are comprised of a response shell, which contains message responses, which, in turn, can contain the other response types. Therefore, responses contain multiple levels of nested messages. This section details the types of responses that can occur and the meanings of status codes included in those responses. The example at the end of this section shows a full response with many nested messages.

Note: The responses discussed in this section are specific to PI Web API OMF endpoint and are not part of the OMF specification. Other implementations of OMF, such as Edge System and AVEVA Cloud Services, do not use these responses.