Updating a Digital Twin Model

Update a digital twin model for your Internet of Things (IoT).

When you update an existing option applied to a digital twin model, you change only the value you can not add a new value to a digital twin model using this update option.

For more information, see Scenario: Add JSON Schema Validation to a Digital Twin Model and Scenario: Working with IoT Digital Twins.

  • Use the update option to update the value of an existing IoT digital twin model option.
    1. On the Domains list page, select the domain that you want to work with. If you need help finding the IoT domains list page or an IoT domain, see Listing IoT Domains.
    2. Select the Digital twin models tab.
    3. Select the digital twin model name. Select Edit to update the name or description for this model, avoid entering any confidential information, and then select Update.
    4. Select the Associated digital twin instances tab to view the associated digital twin instances and view its details. Or from the Actions menu at the end of the row, you can Delete the associated digital twin instance, Manage tags, or Copy the OCID for the digital twin instance associated to this digital twin model.
    5. Select the Associated digital twin adapters tab, select the adapter to view the associated digital twin adapter's details including the Envelopes & Routes and Tags. Or from the Actions menu at the end of the row, you can Delete the associated digital twin adapter, Manage tags, or Copy the OCID for the digital twin adapter associated to this digital twin model.

      From the digital twin model list, select the Actions menu at the end of the row to copy the digital twin model to another IoT domain, Delete, Manage tags, or copy the OCID.

  • Use the update option to update the value of an existing IoT digital twin model option.

    Use the oci iot digital-twin-model update command and required parameters to update a digital twin model. You can update a digital twin's description, display name, defined tags, or free form tags.

    Use this command and required parameters to update a digital twin model's description:

    oci iot digital-twin-model update --digital-twin-model-id <digital-twin-model-OCID> --description "<updated-digital-twin-model-description>"
    Use this command and required parameters to update a digital twin model's display name:
    oci iot digital-twin-model update --digital-twin-model-id <digital-twin-model-OCID> --display-name "<updated-digital-twin-model-display-name>"
    To update a digital twin model's free form tags, you can define key value pairs as in this example, or a path to a tags.json file as in the following example below:
    oci iot digital-twin-model update --digital-twin-model-id <digital-twin-model-OCID> --defined-tags '{"<key>": "<value>"}'
    For more information, see Working with Defined Tags.
    To update a digital twin model's defined tags, use a .json file to define the tags, and include a path a tags.json file as in the example:
    oci iot digital-twin-model update --digital-twin-model-id <digital-twin-model-OCID> --freeform-tags file://tags.json
    For more information, see Understanding Free-form Tags.

    For a complete list of parameters and values for CLI commands, see CLI Command Reference.

  • Run the UpdateDigitalTwinModel operation to update a digital twin model.