Message types

Open Message Format (OMF) messages are organized into the following primary message types:

• Schema messages are used to define metadata and structure, including types, containers, and relationships between types.

• Instance messages are used to transmit runtime information, model structure, including entities, events, streaming data, and relationships between instances.

Message payloads structured as an object containing multiple typed arrays, where each array represents a specific kind of OMF object. OMF 2.0 messages group objects into named arrays within a single JSON object. Each array contains only objects of that specific kind, and the array name explicitly defines how the objects should be interpreted.

For example:

{

"Types": [ ... ],

"Containers": [ ... ],

"Relationships": [ ... ]

}

Note: Legacy OMF message types (type, container, and data) remain supported for compatibility with existing implementations as long as the OMF version header is 1.0, 1.1 or 1.2. When utilizing the 2.0 version header, all type, container, and data messages are rejected.

If you are defining structure, use a Schema message with typed arrays like Types and Containers.

If you are sending data, use an Instance message with typed arrays like Entities, Events, and StreamingData.