Open Message Format
- Last UpdatedAug 01, 2023
- 2 minute read
API for sending OMF messages.
Post OMF Message
Request
POST /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/omf
Parameters
string tenantId
Tenant identifier.string namespaceId
Namespace identifier.
Request Headers
| Header | Type | Required | Description |
|---|---|---|---|
| MessageType | string | true | Describes the type of message contained in the message body. One of: type, container, or data. |
| MessageFormat | string | true | Describes the data serialization format employed in the message body. Currently limited to json. |
| OmfVersion | string | true | Specifies the version of the Open Message Format used in the message. Current supported versions are 1.0, 1.1, and 1.2. |
| Action | string | false | Describes the action to be performed using the data in the message body. One of: create, update, or delete. If omitted, create is assumed. |
| Compression | string | false | The compression algorithm used to compress the message body. Currently limited to gzip. If not specified, the message body is assumed to be uncompressed. |
Response
| Status Code | Body Type | Description |
|---|---|---|
| 202 | OmfResponseBody | An Operation-Id which can be used to troubleshoot data ingress errors. |
| 400 | ErrorResponseBody | Bad request |
| 401 | ErrorResponseBody | Unauthorized |
| 403 | ErrorResponseBody | Forbidden |
| 404 | ErrorResponseBody | Resource not found |
| 408 | ErrorResponseBody | Request timeout |
| 413 | ErrorResponseBody | Payload too large |
| 415 | ErrorResponseBody | Unsupported media type |
| 500 | ErrorResponseBody | Internal server error |
| 503 | ErrorResponseBody | Service unavailable |
| 504 | ErrorResponseBody | Gateway timeout |
Example response body
202 Response
{
"Operation-Id": "9d178275-5385-4414-8cc0-dbf3f8759686"
}
400 Response (ErrorResponseBody)
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
}
}
Definitions
OmfResponseBody
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Operation-Id | string | false | true | The Operation-Id associated with this request. If there are any issues with data flow, contact AVEVA Technical Support with this value. |
{
"Operation-Id": "9d178275-5385-4414-8cc0-dbf3f8759686"
}
ErrorResponseBody
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| OperationId | string | false | true | None |
| Error | string | false | true | None |
| Reason | string | false | true | None |
| Resolution | string | false | true | None |
| Parameters | object | false | true | None |
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"Parameters": {
"property1": "string",
"property2": "string"
}
}