Http Behaviors
- Last UpdatedOct 09, 2024
- 2 minute read
While the Open Message Format (OMF) specification does not define a particular binary message protocol, AVEVA systems accepting OMF over HTTP conform to a set of behaviors described in this section.
Message Size
The body of an OMF message has a maximum size of 192KB. A request with a body size exceeding the maximum will be rejected with an HTTP response code of 413 Payload Too Large. Compression is highly recommended for optimal performance.
HTTP Status Codes
The following status codes are possible to be returned by AVEVA products accepting OMF messages over HTTP. Not all end points will respond with the same error codes due to asynchronous message processing.
|
Status code |
Description |
|---|---|
|
200 OK |
The OMF message was successfully processed. Response body contains additional information. |
|
201 Created |
The OMF message was successfully processed and one or more resources were created. |
|
202 Accepted |
The OMF message was received and has been successfully queued to be processed. |
|
204 No Content |
The OMF message was successfully processed, but there is no additional information to return. |
|
400 Bad Request |
The OMF message was malformed or not understood. The client should not retry sending the message without modifications. |
|
401 Unauthorized |
Authentication failed. |
|
403 Forbidden |
Authentication succeeded, but not authorized. |
|
404 Not Found |
A referenced resource was not found. |
|
409 Conflict |
The OMF message contains a conflict with an existing destination resource. |
|
413 Payload Too Large |
Payload size exceeds OMF body size limit. |
|
500 Internal Server Error |
The server encountered an unexpected condition. |
|
501 Not Implemented |
A feature requested is not available on the end point. Generally, unsupported OMF features are ignored; however, when an operation type or a specific aspect of an OMF resource cannot be represented, this error may be returned. |
|
503 Service Unavailable |
The server is currently unavailable, retry later. |