Namespace Oci.IotService.Models

The digital twin adapter maps incoming data from IoT device into the corresponding digital twin instance. It defines the envelope structure, reference payload, routing and transformation rules using JSON Path and JQ to normalize the raw device data within the IoT domain.
To use any API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. If you are an administrator who needs to create policies to grant users access, see Getting Started with Policies.

DigitalTwinAdapterCollection

Results of a digital twin adapter search. Contains both summary and additional metadata information.

DigitalTwinAdapterEnvelopeMapping

Maps the metadata fields from the inbound payload using JQ. These mappings allow you to extract specific metadata such as timestamps using JQ expressions.

DigitalTwinAdapterInboundEnvelope

Payload containing device-specific metadata and optional value mappings used to interpret or transform that metadata. This structure includes the device endpoint, the actual payload, and an optional envelope mapping that applies JQ expressions to extract or reshape the data as needed.

DigitalTwinAdapterInboundRoute

Defines how inbound device payloads should be routed and mapped within a digital twin context. Routes are evaluated in the order they are defined, and only the first matching condition is processed. A final default route (with a condition that always evaluates to true) is recommended for fallback handling.

DigitalTwinAdapterJsonPayload

DigitalTwinAdapterPayload

Reference payload structure template received from IoT device. This payload must specify its content type using the dataFormat property.

DigitalTwinAdapterPayloadModelConverter

DigitalTwinAdapterSummary

Summary information about a digital twin adapter.

DigitalTwinInstance

A digital twin instance is a virtual representation of a physical IoT device within the IoT domain.
To use any API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. If you are an administrator who needs to create policies to grant users access, see Getting Started with Policies.

DigitalTwinInstanceCollection

Results of digital twin instance search. Contains both summary and additional metadata information

DigitalTwinInstanceSummary

Summary of the digital twin instance

DigitalTwinModel

A digital twin model, defined using Digital Twins Definition Language, specifies the schema for digital twin instance, including its components, properties, telemetry, commands, and relationships within the IoT domain.
To use any API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. If you are an administrator who needs to create policies to grant users access, see Getting Started with Policies.

DigitalTwinModelCollection

Results of a digital twin model search. Contains both summary and additional metadata information.

DigitalTwinModelSummary

Summary of the digital twin model.

DigitalTwinRelationship

A digital twin relationship represents an association between two digital twin instances. It can include properties to describe the nature and context of the association within the IoT domain.
To use any API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. If you are an administrator who needs to create policies to grant users access, see Getting Started with Policies.

DigitalTwinRelationshipCollection

Results of digital twin relationships search. Contains both summary and additional metadata information

DigitalTwinRelationshipSummary

Describes digital twin relationship summary

DirectDataAccessDetails

This contains configuration for direct data access.

ErrorDetails

Error Information.

FileFamily

File Storage resources used to validate networkConfig.fileStorageMounts for an IoT flow runtime.

FileStorageMountDetails

Details about a File Storage mount for an IoT flow runtime.

InvokeRawBinaryCommandDetails

Binary data payload definition

InvokeRawCommandDetails

Definition of unstructured command invocation payload

InvokeRawCommandDetailsModelConverter

InvokeRawJsonCommandDetails

Json data payload definition

InvokeRawTextCommandDetails

Text data payload definition

IotDomain

An IoT domain is an Oracle Cloud Infrastructure resource that provides a managed environment for organizing and managing digital twin resources, such as models, adapters, instances and relationships, within a compartment and IoT domain group.
To use any API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. If you are an administrator who needs to create policies to grant users access, see Getting Started with Policies.

IotDomainCollection

Results of an IoT domain search. Contains both summary items and other information, such as metadata.

IotDomainGroup

An IoT domain group is an Oracle Cloud Infrastructure resource that provides a managed environment for organizing and managing IoT domains, within a compartment.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

IotDomainGroupCollection

Results of an IoT Domain Group search. Contains both summary and additional metadata information.

IotDomainGroupSummary

Summary information about an IoT Domain Group.

IotDomainSummary

Summary information about a IoT domain.

IotFlowRuntime

An IoT flow runtime is a managed Node-RED runtime in an IoT domain for building and running Node-RED flows.

IotFlowRuntimeCollection

A collection of IoT flow runtime summary items.

IotFlowRuntimeSummary

Summary information about an IoT flow runtime.

Log

Log resource used to validate logConfig.logId for an IoT flow runtime.

LogConfigDetails

Logging configuration for an IoT flow runtime.

LogGroup

Log group resource used to validate logConfig.logGroupId for an IoT flow runtime.

NetworkConfigDetails

Network access configuration for an IoT flow runtime.

NetworkSecurityGroup

Network security group resource used to validate networkConfig.networkSecurityGroupIds for an IoT flow runtime.

OrdsDataAccessDetails

This contains configuration for ORDS data access.

Subnet

Subnet resource used to validate networkConfig.subnetId for an IoT flow runtime.

UpdateDigitalTwinAdapterDetails

The information to be updated for the given digital twin adapter.

UpdateDigitalTwinInstanceDetails

The information to be updated for the given digital twin instance.

UpdateDigitalTwinModelDetails

The information to be updated for the given digital twin model.

UpdateDigitalTwinRelationshipDetails

The information to be updated for the given digital twin relationship.

UpdateIotDomainDetails

The information to be updated for the given IoT domain.

UpdateIotDomainGroupDetails

The information to be updated for the given IoT domain group.

UpdateIotFlowRuntimeDetails

Details for updating an IoT flow runtime. This operation supports partial updates. When networkConfig is omitted, the existing network configuration is preserved. When networkConfig is provided, the complete network configuration is replaced. To remove the network configuration, pass networkConfig as null.

Vcn

Vcn resource for validation of dbAllowListedVcns

WorkRequest

An asynchronous work request helps monitor long-running operations. When you initiate a long-running operation, the service creates a work request. This work request acts as an activity log, allowing you to track each step of the operation\u2019s progress. Each work request has an OCID, enabling programmatic interaction and automation.

WorkRequestError

An error encountered while performing an operation that is tracked by a work request.

WorkRequestErrorCollection

A list of work request errors. Can contain both errors and other information, such as metadata.

WorkRequestLogEntry

A log message from performing an operation that is tracked by a work request.

WorkRequestLogEntryCollection

A list of work request logs. Can contain both logs and other information, such as metadata.

WorkRequestResource

A resource created or operated on by a work request.

WorkRequestSummary

Summary information about an asynchronous work request.

WorkRequestSummaryCollection

A list of work requests. Can contain both work requests and other information, such as metadata.

Enums

ActionType

Possible types of actions.

ChangeIotDomainDataRetentionPeriodDetails.TypeEnum

ConfigureIotDomainDataAccessDetails.TypeEnum

CreateIotDomainGroupDetails.TypeEnum

CreateIotFlowRuntimeDetails.ScaleEnum

DigitalTwinAdapterPayload.DataFormatEnum

DigitalTwinInstanceConnectivityType

Connectivity type of the digital twin instance. Possible values are: DIRECT - The instance connects directly to the cloud. INDIRECT - The instance connects to the cloud through a gateway. GATEWAY - The instance acts as a gateway and relays data from other instances. NONE - The instance is not expected to have any connectivity.