Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

Open Message Format (OMF)

Update entities

  • Last UpdatedAug 19, 2026
  • 1 minute read

After an entity has been created, you can update it to reflect changes to its metadata, relationships, or property values. OMF 2.0 supports entity update operations that allow applications to keep entity information synchronized as equipment, assets, and other modeled objects change.

Depending on the update scenario, you can either replace the entire entity representation or patch only the properties that have changed. Replacing an entity is useful when you want to submit a complete updated definition, while patching allows you to modify selected values without resending the entire entity payload.

Delete an entity

Use a delete operation to remove an existing entity from the data model. Deleting an entity permanently removes the entity and its associated metadata, making it unavailable for future references or updates.

The following example deletes an entity component using its type and instance identifiers.

omfversion: 2.0

messagetype: instance

action: delete

messageformat: json

{

"entities": [

{

"typeid": "Tank", // Deletes the Tank-101 entity component remove to delete a component

"id": "Tank-101"

}

]

}

Related Links