openapi: 3.2.0 info: description: "Use the Internet of Things (IoT) API to manage IoT domain groups, domains, and digital twin resources including models, adapters, instances, and relationships. \nFor more information, see [Internet of Things](https://docs.oracle.com/iaas/Content/internet-of-things/home.htm).\n" title: Internet of Things Iot API version: '20250531' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/905e2b54bc20967880e93f440014b90f140aa2d80b670abdb334c9d991fb6abd.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Internet of Things API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/905e2b54bc20967880e93f440014b90f140aa2d80b670abdb334c9d991fb6abd.yaml what: the harvested document for Internet of Things API servers: - url: http://127.0.0.1/20250531 - url: https://127.0.0.1/20250531 tags: - name: iot paths: /digitalTwinAdapters: get: description: 'Retrieves a list of digital twin adapters within the specified IoT domain. ' operationId: ListDigitalTwinAdapters parameters: - $ref: '#/components/parameters/IotDomainIdQueryParam' - $ref: '#/components/parameters/IdQueryParam' - $ref: '#/components/parameters/DigitalTwinModelSpecUriQueryParam' - $ref: '#/components/parameters/DigitalTwinModelIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationPageQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of DigitalTwinAdapterSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DigitalTwinAdapterCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of digital twin adapters within the specified IoT domain. tags: - iot x-related-resource: '#/definitions/DigitalTwinAdapter' post: description: Creates a new digital twin adapter. operationId: CreateDigitalTwinAdapter parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The digital twin adapter was successfully created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DigitalTwinAdapter' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new digital twin adapter. tags: - iot x-example: "POST /20250531/digitalTwinAdapters\nHost: iot.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"iotDomainId\": \"<iotDomainId>\",\n \"digitalTwinModelId\": \"<digitalTwinModelId>\",\n \"digitalTwinModelSpecUri\": \"<digitalTwinModelSpecUri>\",\n \"inboundEnvelope\": {\n \"envelopeMapping\": {\n \"timeObserved\": \"$.time\"\n },\n \"referenceEndpoint\": \"/\",\n \"referencePayload\": {\n \"data\": {\n \"temperature\": 0,\n \"time\": \"2025-09-11T07:56:31.757466Z\"\n },\n \"dataFormat\": \"JSON\"\n }\n },\n \"inboundRoutes\": [\n {\n \"condition\": \"*\",\n \"description\": \"Default condition\",\n \"payloadMapping\": {\n \"$.temperature\": \"$.temperature\"\n }\n }\n ]\n}\n" x-related-resource: '#/definitions/DigitalTwinAdapter' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDigitalTwinAdapterDetails' description: Details for the new digital twin adapter. required: true /digitalTwinAdapters/{digitalTwinAdapterId}: delete: description: Deletes the digital twin adapter identified by the specified OCID. operationId: DeleteDigitalTwinAdapter parameters: - $ref: '#/components/parameters/DigitalTwinAdapterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The digital twin adapter was successfully deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the digital twin adapter identified by the specified OCID. tags: - iot x-related-resource: '#/definitions/DigitalTwinAdapter' get: description: Retrieves the digital twin adapter identified by the specified OCID. operationId: GetDigitalTwinAdapter parameters: - $ref: '#/components/parameters/DigitalTwinAdapterIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The digital twin adapter was successfully retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DigitalTwinAdapter' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves the digital twin adapter identified by the specified OCID. tags: - iot put: description: Updates the details of digital twin adapter identified by the specified OCID. operationId: UpdateDigitalTwinAdapter parameters: - $ref: '#/components/parameters/DigitalTwinAdapterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The digital twin adapter was successfully updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DigitalTwinAdapter' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the details of digital twin adapter identified by the specified OCID. tags: - iot x-related-resource: '#/definitions/DigitalTwinAdapter' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDigitalTwinAdapterDetails' description: The digital twin adapter details to be updated. required: true /digitalTwinInstances: get: description: 'Retrieves a list of digital twin instances within the specified IoT domain. ' operationId: ListDigitalTwinInstances parameters: - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationPageQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/DigitalTwinModelIdQueryParam' - $ref: '#/components/parameters/DigitalTwinModelSpecUriQueryParam' - $ref: '#/components/parameters/DigitalTwinInstanceConnectivityTypeQueryParam' - $ref: '#/components/parameters/IotDomainIdQueryParam' - $ref: '#/components/parameters/IdQueryParam' responses: 200: description: A page of DigitalTwinInstanceSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DigitalTwinInstanceCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of all digital twin instances within the specified IoT domain. tags: - iot x-related-resource: '#/definitions/DigitalTwinInstance' post: description: 'Creates a new digital twin instance. ' operationId: CreateDigitalTwinInstance parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The digital twin instance was successfully created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DigitalTwinInstance' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new digital twin instance. tags: - iot x-related-resource: '#/definitions/DigitalTwinInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDigitalTwinInstanceDetails' description: Details for the new digital twin instance. required: true /digitalTwinInstances/{digitalTwinInstanceId}: delete: description: Deletes the digital twin instance identified by the specified OCID. operationId: DeleteDigitalTwinInstance parameters: - $ref: '#/components/parameters/DigitalTwinInstanceIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The digital twin instance was successfully deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the digital twin instance identified by the specified OCID. tags: - iot x-related-resource: '#/definitions/DigitalTwinInstance' get: description: Retrieves the digital twin instance identified by the specified OCID. operationId: GetDigitalTwinInstance parameters: - $ref: '#/components/parameters/DigitalTwinInstanceIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The digital twin instance was successfully retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DigitalTwinInstance' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves the digital twin instance identified by the specified OCID. tags: - iot put: description: Updates the details of digital twin instance identified by the specified OCID. operationId: UpdateDigitalTwinInstance parameters: - $ref: '#/components/parameters/DigitalTwinInstanceIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The digital twin instance was successfully updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DigitalTwinInstance' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the details of digital twin instance identified by the specified OCID. tags: - iot x-related-resource: '#/definitions/DigitalTwinInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDigitalTwinInstanceDetails' description: The digital twin instance details to be updated. required: true /digitalTwinInstances/{digitalTwinInstanceId}/actions/invokeRawCommand: post: description: 'Invokes the raw command on the specified digital twin instance. ' operationId: InvokeRawCommand parameters: - $ref: '#/components/parameters/DigitalTwinInstanceIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The raw command to the specified digital twin instance was successfully accepted. headers: Location: description: URL where the status of command invocation could be retrieved schema: type: string format: url opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Invokes the raw command on the specified digital twin instance. tags: - iot x-related-resource: '#/definitions/DigitalTwinInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/InvokeRawCommandDetails' description: Details for the raw command invocation. required: true /digitalTwinInstances/{digitalTwinInstanceId}/content: get: description: 'Retrieves the content associated with a digital twin instance identified by the specified OCID. The content can be retrieved only when a model is associated with the digital twin instance. ' operationId: GetDigitalTwinInstanceContent parameters: - $ref: '#/components/parameters/DigitalTwinInstanceIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IncludeDigitalTwinInstanceContentMetadataQueryParam' responses: 200: description: The content of digital twin instance was successfully retrieved only when a model is associated with it. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: additionalProperties: type: object maxProperties: 512 type: object application/ld+json: schema: additionalProperties: type: object maxProperties: 512 type: object 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: description: 'The specified digital twin instance does not exist, or no model is associated with it. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' application/ld+json: schema: $ref: '#/components/schemas/ErrorDetails' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Retrieves the content associated with a digital twin instance identified by the specified OCID. The content can be retrieved only when a model is associated with the digital twin instance. ' tags: - iot x-example: 'GET /20250531/digitalTwinInstances/<digitalTwinInstanceId>/content Host: iot.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DigitalTwinInstance' /digitalTwinModels: get: description: 'Retrieves a list of digital twin models within the specified IoT domain. ' operationId: ListDigitalTwinModels parameters: - $ref: '#/components/parameters/IdQueryParam' - $ref: '#/components/parameters/IotDomainIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/DigitalTwinModelSpecUriStartsWithQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationPageQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of DigitalTwinModelSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DigitalTwinModelCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieve a list of digital twin models within the specified IoT domain. tags: - iot x-related-resource: '#/definitions/DigitalTwinModel' post: description: 'Creates a new digital twin model. ' operationId: CreateDigitalTwinModel parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The digital twin model was successfully created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DigitalTwinModel' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Create a new digital twin model. tags: - iot x-example: "POST /20250531/digitalTwinModels\nHost: iot.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"iotDomainId\": \"<iotDomainId>\",\n \"spec\": {\n \"@id\": \"dtmi:example:device;1\",\n \"@type\": \"Interface\",\n \"@context\": \"dtmi:dtdl:context;3\",\n \"displayName\": \"IoT Device Model\",\n \"description\": \"Represents a simple IoT device with temperature property.\",\n \"contents\": [\n {\n \"@type\": \"Property\",\n \"name\": \"temperature\",\n \"schema\": \"double\",\n \"displayName\": \"Temperature\",\n \"description\": \"The current temperature reading of the device.\"\n }\n ]\n }\n}\n" x-related-resource: '#/definitions/DigitalTwinModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDigitalTwinModelDetails' description: Details for the new digital twin model. required: true /digitalTwinModels/{digitalTwinModelId}: delete: description: Deletes the digital twin model identified by the specified OCID. operationId: DeleteDigitalTwinModel parameters: - $ref: '#/components/parameters/DigitalTwinModelIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The digital twin model was successfully deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the digital twin model identified by the specified OCID. tags: - iot x-related-resource: '#/definitions/DigitalTwinModel' get: description: Retrieves the digital twin model identified by the specified OCID. operationId: GetDigitalTwinModel parameters: - $ref: '#/components/parameters/DigitalTwinModelIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The digital twin model was successfully retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DigitalTwinModel' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves the digital twin model identified by the specified OCID. tags: - iot put: description: Updates the details of the digital twin model identified by the specified OCID. operationId: UpdateDigitalTwinModel parameters: - $ref: '#/components/parameters/DigitalTwinModelIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The digital twin model was successfully updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DigitalTwinModel' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the details of the digital twin model identified by the specified OCID. tags: - iot x-related-resource: '#/definitions/DigitalTwinModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDigitalTwinModelDetails' description: The digital twin model details to be updated. required: true /digitalTwinModels/{digitalTwinModelId}/spec: get: description: Retrieves the spec of digital twin model identified by the specified OCID. operationId: GetDigitalTwinModelSpec parameters: - $ref: '#/components/parameters/DigitalTwinModelIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The digital twin model spec was successfully retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: additionalProperties: type: object maxProperties: 512 type: object application/ld+json: schema: additionalProperties: type: object maxProperties: 512 type: object 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves the spec of digital twin model identified by the specified OCID. tags: - iot x-example: 'GET /20250531/digitalTwinModels/<digitalTwinModelId>/spec Host: iot.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DigitalTwinModel' /digitalTwinRelationships: get: description: 'Retrieves a list of digital twin relationships within the specified IoT domain. ' operationId: ListDigitalTwinRelationships parameters: - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/DigitalTwinRelationshipContentPathQueryParam' - $ref: '#/components/parameters/DigitalTwinRelationshipSourceInstanceIdQueryParam' - $ref: '#/components/parameters/DigitalTwinRelationshipTargetInstanceIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationPageQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IotDomainIdQueryParam' - $ref: '#/components/parameters/IdQueryParam' responses: 200: description: A page of DigitalTwinRelationship summary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DigitalTwinRelationshipCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of digital twin relationships within the specified IoT domain. tags: - iot x-related-resource: '#/definitions/DigitalTwinRelationship' post: description: 'Creates a new digital twin relationship. ' operationId: CreateDigitalTwinRelationship parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The digital twin relationship was successfully created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DigitalTwinRelationship' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new digital twin relationship. tags: - iot x-related-resource: '#/definitions/DigitalTwinRelationship' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDigitalTwinRelationshipDetails' description: Details for the new digital twin relationship. required: true /digitalTwinRelationships/{digitalTwinRelationshipId}: delete: description: Deletes the digital twin relationship identified by the specified OCID. operationId: DeleteDigitalTwinRelationship parameters: - $ref: '#/components/parameters/DigitalTwinRelationshipIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The digital twin relationship was successfully deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the digital twin relationship identified by the specified OCID. tags: - iot x-related-resource: '#/definitions/DigitalTwinRelationship' get: description: Retrieves the digital twin relationship identified by the specified OCID. operationId: GetDigitalTwinRelationship parameters: - $ref: '#/components/parameters/DigitalTwinRelationshipIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The digital twin relationship was successfully retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DigitalTwinRelationship' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves the digital twin relationship identified by the specified OCID. tags: - iot x-related-resource: '#/definitions/DigitalTwinRelationship' put: description: Updates the details of digital twin relationship identified by the specified OCID. operationId: UpdateDigitalTwinRelationship parameters: - $ref: '#/components/parameters/DigitalTwinRelationshipIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The digital twin relationship was successfully updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DigitalTwinRelationship' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the details of digital twin relationship identified by the specified OCID. tags: - iot x-related-resource: '#/definitions/DigitalTwinRelationship' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDigitalTwinRelationshipDetails' description: The digital twin relationship details to be updated. required: true /iotDomainGroups: get: description: 'Retrieves a list of IoT domain groups within the specified compartment. ' operationId: ListIotDomainGroups parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/IdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/IotDomainGroupLifecycleStateQueryParam' - $ref: '#/components/parameters/IotDomainGroupTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of IotDomainGroupSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IotDomainGroupCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of IoT domain groups within the specified compartment. tags: - iot x-related-resource: '#/definitions/IotDomainGroup' post: description: 'Creates a new IoT domain group. ' operationId: CreateIotDomainGroup parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: 'The IoT domain group was successfully created. This is an asynchronous operation and its status can be tracked using the work request ID. ' headers: content-location: description: Same as location. schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URL for the created IoT Domain Group. The IoT Domain Group OCID is generated after this request is sent. schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IotDomainGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new IoT domain group. tags: - iot x-related-resource: '#/definitions/IotDomainGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateIotDomainGroupDetails' description: Details for the new IoT domain group. required: true /iotDomainGroups/{iotDomainGroupId}: delete: description: Deletes the IoT domain group identified by the specified OCID. operationId: DeleteIotDomainGroup parameters: - $ref: '#/components/parameters/IotDomainGroupIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The IoT Domain Group will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the IoT domain group identified by the specified OCID. tags: - iot x-related-resource: '#/definitions/IotDomainGroup' get: description: Retrieves the IoT domain group identified by the specified OCID. operationId: GetIotDomainGroup parameters: - $ref: '#/components/parameters/IotDomainGroupIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The IoT domain group was successfully retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IotDomainGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves the IoT domain group identified by the specified OCID. tags: - iot put: description: Updates the details of IoT domain group identified by the specified OCID. operationId: UpdateIotDomainGroup parameters: - $ref: '#/components/parameters/IotDomainGroupIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The IoT Domain Group will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the details of IoT domain group identified by the specified OCID. tags: - iot x-related-resource: '#/definitions/IotDomainGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateIotDomainGroupDetails' description: The IoT domain group details to be updated. required: true /iotDomainGroups/{iotDomainGroupId}/actions/changeCompartment: post: description: 'Moves an IoT domain group to a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeIotDomainGroupCompartment parameters: - $ref: '#/components/parameters/IotDomainGroupIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The IoT domain group will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Changes the compartment of an IoT domain group. tags: - iot x-related-resource: '#/definitions/IotDomainGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeIotDomainGroupCompartmentDetails' description: Details for changing the IoT domain group compartment. required: true /iotDomainGroups/{iotDomainGroupId}/actions/configureDataAccess: post: description: 'Updates an IoT domain Group Data Access. ' operationId: ConfigureIotDomainGroupDataAccess parameters: - $ref: '#/components/parameters/IotDomainGroupIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The IoT domain Group Data access will be configured. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Configures the Data Access of an IoT Domain Group. tags: - iot x-related-resource: '#/definitions/IotDomainGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigureIotDomainGroupDataAccessDetails' description: Details for configuring data access. required: true /iotDomains: get: description: 'Retrieves a list of IoT domains within the specified compartment. ' operationId: ListIotDomains parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/IdQueryParam' - $ref: '#/components/parameters/IotDomainGroupIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/IotDomainLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of IotDomainSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IotDomainCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves a list of IoT domains within the specified compartment. tags: - iot x-related-resource: '#/definitions/IotDomain' post: description: 'Creates a new IoT domain. ' operationId: CreateIotDomain parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: 'The IoT domain was successfully created. This is an asynchronous operation and its status can be tracked using the work request ID. ' headers: content-location: description: Same as location. schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URL for the created IoT domain. The IoT domain OCID is generated after this request is sent. schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IotDomain' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new IoT domain. tags: - iot x-related-resource: '#/definitions/IotDomain' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateIotDomainDetails' description: Details for the new IoT domain. required: true /iotDomains/{iotDomainId}: delete: description: Deletes the IoT domain identified by the specified OCID. operationId: DeleteIotDomain parameters: - $ref: '#/components/parameters/IotDomainIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The IoT domain will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the IoT domain identified by the specified OCID. tags: - iot x-related-resource: '#/definitions/IotDomain' get: description: Retrieves the IoT domain identified by the specified OCID. operationId: GetIotDomain parameters: - $ref: '#/components/parameters/IotDomainIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The IoT domain was successfully retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IotDomain' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves the IoT domain identified by the specified OCID. tags: - iot put: description: Updates the details of IoT domain identified by the specified OCID. operationId: UpdateIotDomain parameters: - $ref: '#/components/parameters/IotDomainIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The IoT domain will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the details of IoT domain identified by the specified OCID. tags: - iot x-related-resource: '#/definitions/IotDomain' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateIotDomainDetails' description: The IoT domain details to be updated. required: true /iotDomains/{iotDomainId}/actions/changeCompartment: post: description: 'Moves an IoT domain to a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeIotDomainCompartment parameters: - $ref: '#/components/parameters/IotDomainIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The IoT domain will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Changes the compartment of an IoT domain. tags: - iot x-related-resource: '#/definitions/IotDomain' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeIotDomainCompartmentDetails' description: Details for changing the IoT domain compartment. required: true /iotDomains/{iotDomainId}/actions/changeDataRetentionPeriod: post: description: 'Updates Data Retention Period of the IoT Domain. ' operationId: ChangeIotDomainDataRetentionPeriod parameters: - $ref: '#/components/parameters/IotDomainIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The IoT domain Data retention period will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Changes the Data Retention Period of IoT Domain Data. tags: - iot x-example: "POST /20250531/iotDomains/<iotDomainId>/actions/changeDataRetentionPeriod\nHost: iot.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"type\": \"RAW_DATA\",\n \"dataRetentionPeriodInDays\": 60\n}\n" x-related-resource: '#/definitions/IotDomain' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeIotDomainDataRetentionPeriodDetails' description: Details for changing data retention period of IoT domain data. required: true /iotDomains/{iotDomainId}/actions/configureDataAccess: post: description: 'Updates an IoT domain Data Access. ' operationId: ConfigureIotDomainDataAccess parameters: - $ref: '#/components/parameters/IotDomainIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The IoT domain Data access will be configured. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Configures the Data Access of IoT Domain. tags: - iot x-related-resource: '#/definitions/IotDomain' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigureIotDomainDataAccessDetails' description: Details for configuring data access. required: true /workRequests: get: description: 'Lists work requests in the specified compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestIdentifierQueryParam' - $ref: '#/components/parameters/WorkRequestStatusQueryParam' - $ref: '#/components/parameters/ResourceIdentifierQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' responses: 200: description: List of work requests retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List work requests tags: - iot x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: get: description: Retrieves the status of the work request with the given ID. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Work request retrieved successfully. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get work request status tags: - iot x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Lists errors associated with the specified work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: List of work request errors retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List work request errors tags: - iot x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/logs: get: description: 'Lists the logs associated with the specified work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: List of work request logs retrieved successfully. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List work request logs tags: - iot x-related-resource: '#/definitions/WorkRequest' components: schemas: DigitalTwinInstance: description: "A digital twin instance is a virtual representation of a physical IoT device within the IoT domain.\n\nTo use any API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. \nIf you are an administrator who needs to create policies to grant users access, see\n[Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).\n" properties: authId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance. maxLength: 255 minLength: 1 type: string connectivityType: default: DIRECT description: Connectivity type of the digital twin instance enum: - DIRECT - INDIRECT - GATEWAY - NONE type: string x-obmcs-top-level-enum: '#/definitions/DigitalTwinInstanceConnectivityType' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A short description of the resource. ' maxLength: 400 type: string digitalTwinAdapterId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the digital twin adapter. maxLength: 255 minLength: 1 type: string digitalTwinModelId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model. maxLength: 255 minLength: 1 type: string digitalTwinModelSpecUri: description: The URI of the digital twin model specification. maxLength: 128 minLength: 1 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string externalKey: description: 'A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance. This could be a Bluetooth address, Ethernet MAC address, or serial number, depending on the use case. If not provided, the system will automatically generate one. ' maxLength: 64 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object gateways: description: 'An array of unique ids ([OCIDs](/iaas/Content/General/Concepts/identifiers.htm)) of the IoT digital twin instances with connectivityType equals to GATEWAY. ' items: maxLength: 255 minLength: 1 type: string minItems: 1 type: array id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. maxLength: 255 minLength: 1 type: string iotDomainId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the digital twin instance. enum: - ACTIVE - DELETED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time when the resource was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time when the resource was last updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - iotDomainId - connectivityType - displayName - lifecycleState - timeCreated type: object DigitalTwinModelSummary: description: Summary of the digital twin model. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the resource. If left blank, the description will be derived from the spec. maxLength: 400 type: string displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. \nIf left blank, the display name will be derived from the spec.\n" maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. maxLength: 255 minLength: 1 type: string iotDomainId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the digital twin model. enum: - ACTIVE - DELETED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' specUri: description: This is the DTMI (Digital Twin Model Identifier) of the digital twin model as defined in DTDL specification. maxLength: 128 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time when the resource was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time when the resource was last updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - iotDomainId - specUri - displayName - lifecycleState - timeCreated type: object IotDomainSummary: description: Summary information about a IoT domain. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment corresponding to the resource. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A short description of the resource. ' maxLength: 400 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. maxLength: 255 minLength: 1 type: string iotDomainGroupId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain group. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the IoT domain. type: string x-obmcs-enumref: '#/definitions/IotDomain/lifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time when the resource was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time when the resource was last updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - iotDomainGroupId - compartmentId - displayName - lifecycleState - timeCreated type: object WorkRequestSummaryCollection: description: A list of work requests. Can contain both work requests and other information, such as metadata. properties: items: description: A list of work requests. items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object UpdateDigitalTwinAdapterDetails: description: The information to be updated for the given digital twin adapter. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A short description of the resource. ' maxLength: 400 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object inboundEnvelope: $ref: '#/components/schemas/DigitalTwinAdapterInboundEnvelope' inboundRoutes: description: list of routes items: $ref: '#/components/schemas/DigitalTwinAdapterInboundRoute' maxItems: 128 type: array type: object IotDomainGroup: description: "An IoT domain group is an Oracle Cloud Infrastructure resource that provides a managed environment for organizing \nand managing IoT domains, within a compartment.\n\nTo use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to\nan administrator. If you're an administrator who needs to write policies to give users access, see\n[Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).\n" properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment corresponding to the resource. maxLength: 255 minLength: 1 type: string dataHost: description: The host name of the database corresponding to the IoT Domain group. type: string dbAllowListedVcnIds: description: This is an array of VCN OCID (virtual cloud network Oracle Cloud ID) that is allowed to connect the data host. items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array dbConnectionString: description: The connection string used to connect to the data host associated with the IoT domain group. type: string dbTokenScope: description: The token scope used to connect to the data host associated with the IoT domain group. maxLength: 275 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A short description of the resource. ' maxLength: 400 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of an IoT Domain Group. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time when the resource was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time when the resource was last updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string type: default: DEVELOPMENT description: "Type of domain group. DEVELOPMENT uses fewer resources and has a higher Recovery Time Objective (RTO),\nmaking it suitable for development and testing. PRODUCTION is recommended for production workloads. \nLIGHTWEIGHT and STANDARD are deprecated aliases for DEVELOPMENT and PRODUCTION respectively and will be removed \nin a future release.\n" enum: - PRODUCTION - DEVELOPMENT - STANDARD - LIGHTWEIGHT type: string required: - id - compartmentId - type - displayName - lifecycleState - timeCreated type: object IotDomainGroupCollection: description: Results of an IoT Domain Group search. Contains both summary and additional metadata information. properties: items: description: List of IoT Domain Group. items: $ref: '#/components/schemas/IotDomainGroupSummary' type: array required: - items type: object DigitalTwinAdapterCollection: description: 'Results of a digital twin adapter search. Contains both summary and additional metadata information. ' properties: items: description: List of the digital twin adapters. items: $ref: '#/components/schemas/DigitalTwinAdapterSummary' type: array required: - items type: object CreateIotDomainDetails: description: The information about new IoT domain to be created. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment corresponding to the resource. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A short description of the resource. ' maxLength: 400 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object iotDomainGroupId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain group. maxLength: 255 minLength: 1 type: string required: - iotDomainGroupId - compartmentId type: object WorkRequestSummary: description: Summary information about an asynchronous work request. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. ' type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. type: string operationType: description: The asynchronous operation tracked by this work request. enum: - CREATE_IOT_DOMAIN - UPDATE_IOT_DOMAIN - DELETE_IOT_DOMAIN - MOVE_IOT_DOMAIN - MOVE_IOT_DOMAIN_GROUP - CREATE_IOT_DOMAIN_GROUP - UPDATE_IOT_DOMAIN_GROUP - DELETE_IOT_DOMAIN_GROUP - CONFIGURE_DOMAIN_DATA_ACCESS - CONFIGURE_DOMAIN_GROUP_DATA_ACCESS - CHANGE_IOT_DOMAIN_DATA_RETENTION type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: 'Shows the progress of the operation tracked by the work request, as a percentage of the total work that must be performed. ' format: float type: number resources: description: The resources that are affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of the work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the work request was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeFinished: description: 'The date and time the work request was finished, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the work request was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeUpdated: description: 'The date and time the work request was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted DigitalTwinAdapterEnvelopeMapping: description: 'Maps the metadata fields from the inbound payload using JQ. These mappings allow you to extract specific metadata such as timestamps using JQ expressions. ' properties: contentRoot: description: JSON Path string to override the context root before delegating to the adapter of the target digital twin instance. example: $.payload.field.one minLength: 1 type: string target: description: 'Optional. JQ expression to map the target resource, which is externalKey of digital twin instance, the incoming data belongs to. ' type: string timeObserved: description: 'JQ expression to extract the observation timestamp from the payload. If not specified, the system will default to using `timeReceived` as the timestamp. Example: For payload `{"time": "","temp": 65,"hum": 55}` ''timeObserved'' can be mapped as [JQ Expression](https://jqplay.org/) `$.time`. ' type: string type: object ErrorDetails: description: Error Information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message ChangeIotDomainCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment corresponding to the resource. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object UpdateIotDomainGroupDetails: description: The information to be updated for the given IoT domain group. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A short description of the resource. ' maxLength: 400 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object ConfigureIotDomainGroupDataAccessDetails: description: The configuration details for an IoT Domain Group Data Access through allowlisted vcn ids. properties: dbAllowListedVcnIds: description: This is an array of VCN OCID (virtual cloud network Oracle Cloud ID) that is allowed to connect the data host. items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array required: - dbAllowListedVcnIds type: object CreateDigitalTwinRelationshipDetails: description: The information about new digital twin relationship to be created. properties: content: additionalProperties: type: object description: The value(s) of the relationship properties defined in the source digital twin model. maxProperties: 512 type: object contentPath: description: 'Its the name of the relationship that links two digital twin instances. Here, it is the relationship name of the source digital twin model. ' maxLength: 512 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A short description of the resource. ' maxLength: 400 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object iotDomainId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. maxLength: 255 minLength: 1 type: string sourceDigitalTwinInstanceId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of source digital twin instance. ' maxLength: 255 minLength: 1 type: string targetDigitalTwinInstanceId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of target digital twin instance. maxLength: 255 minLength: 1 type: string required: - iotDomainId - contentPath - sourceDigitalTwinInstanceId - targetDigitalTwinInstanceId type: object DigitalTwinRelationshipCollection: description: Results of digital twin relationships search. Contains both summary and additional metadata information properties: items: description: List of digital twin relationships items: $ref: '#/components/schemas/DigitalTwinRelationshipSummary' type: array required: - items type: object DigitalTwinAdapterInboundRoute: description: '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. ' properties: condition: description: 'A boolean expression used to determine whether the following transformation should be processed for the incoming payload. This expression is typically based on fields defined at the inbound Envelope and is evaluated before applying the `payloadMapping`. ' type: string description: description: 'Meaningful write up about the inbound route. ' maxLength: 400 type: string payloadMapping: additionalProperties: type: string description: "A set of key-value JQ expressions used to transform the incoming payload into a shape\ncompatible with the digital twin model's context or schema.\n\nThe keys are target fields (in the digital twin model), and values are JQ expressions\npointing to data in the reference payload.\n\nExample:\nGiven payload:\n{\n \"time\": \"\",\n \"temp\": 65,\n \"hum\": 55\n}\nAnd mapping:\n{\n \"temperature\": \"$.temp\",\n \"humidity\": \"$.hum\",\n \"timeObserved\": \"$.time\"\n}\nThe output will be:\n{\n \"temperature\": 65,\n \"humidity\": 55,\n \"timeObserved\": \"\"\n}\n" example: '{"$.temperature": "$.temperature","$.humidity": "$.humidity"}' maxProperties: 256 type: object referencePayload: $ref: '#/components/schemas/DigitalTwinAdapterPayload' required: - condition type: object DigitalTwinModelCollection: description: Results of a digital twin model search. Contains both summary and additional metadata information. properties: items: description: List of digital twin models. items: $ref: '#/components/schemas/DigitalTwinModelSummary' type: array required: - items type: object DigitalTwinAdapterInboundEnvelope: description: '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](https://stedolan.github.io/jq/) expressions to extract or reshape the data as needed. ' properties: envelopeMapping: $ref: '#/components/schemas/DigitalTwinAdapterEnvelopeMapping' referenceEndpoint: description: 'The device endpoint. ' example: iot/v1/dt/ type: string referencePayload: $ref: '#/components/schemas/DigitalTwinAdapterPayload' required: - referenceEndpoint type: object WorkRequestLogEntry: description: A log message from performing an operation that is tracked by a work request. properties: message: description: A human-readable log message. type: string timestamp: description: 'The date and time the log message was written, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string required: - message - timestamp IotDomain: description: "An IoT domain is an Oracle Cloud Infrastructure resource that provides a managed environment for organizing and managing \ndigital twin resources, such as models, adapters, instances and relationships, within a compartment and IoT domain group.\n\nTo use any API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. \nIf you are an administrator who needs to create policies to grant users access, see\n[Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).\n" properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment corresponding to the resource. maxLength: 255 minLength: 1 type: string dataRetentionPeriodsInDays: $ref: '#/components/schemas/DataRetentionPeriodsInDays' dbAllowListedIdentityGroupNames: description: List of IAM groups of form described in [here](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/mnqmn/#GUID-3634D6C9-A7F1-4875-9925-BAEA2D3C5197) that are allowed to directly connect to the data host. items: type: string maxItems: 5 type: array dbAllowedIdentityDomainHost: description: Host name of identity domain that is used for authenticating connect to data host via ORDS. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A short description of the resource. ' maxLength: 400 type: string deviceHost: description: Host name of an IoT domain, where IoT devices can connect to. type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. maxLength: 255 minLength: 1 type: string iotDomainGroupId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain group. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the IoT domain. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time when the resource was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time when the resource was last updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - iotDomainGroupId - compartmentId - displayName - lifecycleState - timeCreated type: object WorkRequest: description: "An asynchronous work request helps monitor long-running operations. When you initiate a long-running operation, \nthe service creates a work request. This work request acts as an activity log, allowing you to track each \nstep of the operation’s progress. Each work request has an OCID, enabling programmatic interaction and automation.\n" properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. ' type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. type: string operationType: description: The asynchronous operation tracked by this work request. enum: - CREATE_IOT_DOMAIN - UPDATE_IOT_DOMAIN - DELETE_IOT_DOMAIN - MOVE_IOT_DOMAIN - MOVE_IOT_DOMAIN_GROUP - CREATE_IOT_DOMAIN_GROUP - UPDATE_IOT_DOMAIN_GROUP - DELETE_IOT_DOMAIN_GROUP - CONFIGURE_DOMAIN_DATA_ACCESS - CONFIGURE_DOMAIN_GROUP_DATA_ACCESS - CHANGE_IOT_DOMAIN_DATA_RETENTION type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: 'Shows the progress of the operation tracked by the work request as a percentage of the total work to be completed. ' format: float type: number resources: description: The resources that are affected by the work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of the work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the work request was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeFinished: description: 'The date and time the work request was finished, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the work request was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeUpdated: description: 'The date and time the work request was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted UpdateDigitalTwinInstanceDetails: description: 'The information to be updated for the given digital twin instance. ' properties: authId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A short description of the resource. ' maxLength: 400 type: string digitalTwinAdapterId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the digital twin adapter. maxLength: 255 minLength: 1 type: string digitalTwinModelId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model. maxLength: 255 minLength: 1 type: string digitalTwinModelSpecUri: description: The URI of the digital twin model specification. maxLength: 128 minLength: 1 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string externalKey: description: 'A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance. This could be a Bluetooth address, Ethernet MAC address, or serial number, depending on the use case. If not provided, the system will automatically generate one. ' maxLength: 64 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object gateways: description: 'An array of unique ids ([OCIDs](/iaas/Content/General/Concepts/identifiers.htm)) of the IoT digital twin instances with connectivityType equals to GATEWAY. ' items: maxLength: 255 minLength: 1 type: string minItems: 1 type: array type: object DigitalTwinAdapterPayload: description: 'Reference payload structure template received from IoT device. This payload must specify its content type using the `dataFormat` property. ' discriminator: propertyName: dataFormat properties: dataFormat: default: JSON description: Data format of the payload. enum: - JSON example: JSON type: string required: - dataFormat type: object CreateDigitalTwinInstanceDetails: description: The information about new digital twin instance to be created. properties: authId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance. maxLength: 255 minLength: 1 type: string connectivityType: default: DIRECT description: Connectivity type of the digital twin instance enum: - DIRECT - INDIRECT - GATEWAY - NONE type: string x-obmcs-top-level-enum: '#/definitions/DigitalTwinInstanceConnectivityType' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A short description of the resource. ' maxLength: 400 type: string digitalTwinAdapterId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the digital twin adapter. maxLength: 255 minLength: 1 type: string digitalTwinModelId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model. maxLength: 255 minLength: 1 type: string digitalTwinModelSpecUri: description: The URI of the digital twin model specification. maxLength: 128 minLength: 1 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string externalKey: description: 'A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance. This could be a Bluetooth address, Ethernet MAC address, or serial number, depending on the use case. If not provided, the system will automatically generate one. ' maxLength: 64 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object gateways: description: 'An array of unique ids ([OCIDs](/iaas/Content/General/Concepts/identifiers.htm)) of the IoT digital twin instances with connectivityType equals to GATEWAY. ' items: maxLength: 255 minLength: 1 type: string minItems: 1 type: array iotDomainId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. maxLength: 255 minLength: 1 type: string required: - iotDomainId type: object UpdateDigitalTwinRelationshipDetails: description: The information to be updated for the given digital twin relationship. properties: content: additionalProperties: type: object description: The value(s) of the relationship properties defined in the source digital twin model. maxProperties: 512 type: object definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A short description of the resource. ' maxLength: 400 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object IotDomainCollection: description: Results of an IoT domain search. Contains both summary items and other information, such as metadata. properties: items: description: List of IoT domains. items: $ref: '#/components/schemas/IotDomainSummary' type: array required: - items type: object ChangeIotDomainDataRetentionPeriodDetails: description: The configuration details for data retention periods. properties: dataRetentionPeriodInDays: description: The duration (in days) for which data will be retained in the IoT domain. minimum: 16 type: integer type: description: 'The type of data retention period to apply. Allowed values are RAW_DATA, REJECTED_DATA, HISTORIZED_DATA, and RAW_COMMAND_DATA. ' enum: - RAW_DATA - REJECTED_DATA - HISTORIZED_DATA - RAW_COMMAND_DATA type: string required: - type - dataRetentionPeriodInDays type: object DigitalTwinInstanceSummary: description: Summary of the digital twin instance properties: authId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance. maxLength: 255 minLength: 1 type: string connectivityType: default: DIRECT description: Connectivity type of the digital twin instance enum: - DIRECT - INDIRECT - GATEWAY - NONE type: string x-obmcs-top-level-enum: '#/definitions/DigitalTwinInstanceConnectivityType' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A short description of the resource. ' maxLength: 400 type: string digitalTwinAdapterId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the digital twin adapter. maxLength: 255 minLength: 1 type: string digitalTwinModelId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model. maxLength: 255 minLength: 1 type: string digitalTwinModelSpecUri: description: The URI of the digital twin model specification. maxLength: 128 minLength: 1 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string externalKey: description: 'A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance. This could be a Bluetooth address, Ethernet MAC address, or serial number, depending on the use case. If not provided, the system will automatically generate one. ' maxLength: 64 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object gateways: description: 'An array of unique ids ([OCIDs](/iaas/Content/General/Concepts/identifiers.htm)) of the IoT digital twin instances with connectivityType equals to GATEWAY. ' items: maxLength: 255 minLength: 1 type: string minItems: 1 type: array id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. maxLength: 255 minLength: 1 type: string iotDomainId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the digital twin instance. enum: - ACTIVE - DELETED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time when the resource was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time when the resource was last updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - iotDomainId - connectivityType - displayName - lifecycleState - timeCreated type: object WorkRequestResource: description: A resource created or operated on by a work request. properties: actionType: description: "Describes how this resource is affected by the operation tracked in the work request. \nA resource being created, updated, or deleted remains in the IN_PROGRESS state until the work is complete, \nat which point it transitions to CREATED, UPDATED, or DELETED, respectively.\n" enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - RELATED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' entityType: description: The resource type that the work request affects. type: string entityUri: description: The URI path that you can use for a GET request to access the resource metadata. type: string identifier: description: An [OCID](/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource. type: string metadata: additionalProperties: type: string description: Additional information that helps to explain the resource. enum: - IS_DRY_RUN type: object x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceMetadataKey' required: - actionType - entityType - identifier DigitalTwinAdapter: description: "The digital twin adapter maps incoming data from IoT device into the corresponding digital twin instance. \nIt 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.\n\nTo use any API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. \nIf you are an administrator who needs to create policies to grant users access, see\n[Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).\n" properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A short description of the resource. ' maxLength: 400 type: string digitalTwinModelId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model. maxLength: 255 minLength: 1 type: string digitalTwinModelSpecUri: description: The URI of the digital twin model specification. maxLength: 128 minLength: 1 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. maxLength: 255 minLength: 1 type: string inboundEnvelope: $ref: '#/components/schemas/DigitalTwinAdapterInboundEnvelope' inboundRoutes: description: list of routes items: $ref: '#/components/schemas/DigitalTwinAdapterInboundRoute' maxItems: 128 type: array iotDomainId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the digital twin adapter. enum: - ACTIVE - DELETED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time when the resource was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time when the resource was last updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - iotDomainId - digitalTwinModelId - digitalTwinModelSpecUri - displayName - lifecycleState - timeCreated type: object IotDomainGroupSummary: description: Summary information about an IoT Domain Group. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment corresponding to the resource. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A short description of the resource. ' maxLength: 400 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of an IoT Domain Group. type: string x-obmcs-enumref: '#/definitions/IotDomainGroup/lifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time when the resource was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time when the resource was last updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string type: default: DEVELOPMENT description: "Type of domain group. DEVELOPMENT uses fewer resources and has a higher Recovery Time Objective (RTO),\nmaking it suitable for development and testing. PRODUCTION is recommended for production workloads. \nLIGHTWEIGHT and STANDARD are deprecated aliases for DEVELOPMENT and PRODUCTION respectively and will be removed \nin a future release.\n" enum: - PRODUCTION - DEVELOPMENT - STANDARD - LIGHTWEIGHT type: string required: - id - compartmentId - type - displayName - lifecycleState - timeCreated type: object WorkRequestError: description: An error encountered while performing an operation that is tracked by a work request. properties: code: description: 'A machine-usable code for the error that occurred. For a list of error codes, see [API Errors](/iaas/Content/API/References/apierrors.htm). ' type: string message: description: A human-readable error message. type: string timestamp: description: 'The date and time the error occurred, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string required: - code - message - timestamp UpdateDigitalTwinModelDetails: description: The information to be updated for the given digital twin model. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the resource. If left blank, the description will be derived from the spec. maxLength: 400 type: string displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. \nIf left blank, the display name will be derived from the spec.\n" maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object DigitalTwinAdapterSummary: description: Summary information about a digital twin adapter. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A short description of the resource. ' maxLength: 400 type: string digitalTwinModelId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model. maxLength: 255 minLength: 1 type: string digitalTwinModelSpecUri: description: The URI of the digital twin model specification. maxLength: 128 minLength: 1 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. maxLength: 255 minLength: 1 type: string iotDomainId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the the digital twin adapter. enum: - ACTIVE - DELETED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time when the resource was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time when the resource was last updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - iotDomainId - digitalTwinModelId - digitalTwinModelSpecUri - displayName - lifecycleState - timeCreated type: object UpdateIotDomainDetails: description: The information to be updated for the given IoT domain. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A short description of the resource. ' maxLength: 400 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object DigitalTwinInstanceCollection: description: Results of digital twin instance search. Contains both summary and additional metadata information properties: items: description: List of digital twin instances. items: $ref: '#/components/schemas/DigitalTwinInstanceSummary' type: array required: - items type: object DigitalTwinModel: description: "A digital twin model, defined using [Digital Twins Definition Language](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v3/DTDL.v3.md), \nspecifies the schema for digital twin instance, including its components, properties, telemetry, commands, and relationships within the IoT domain.\n\nTo use any API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. \nIf you are an administrator who needs to create policies to grant users access, see\n[Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).\n" properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the resource. If left blank, the description will be derived from the spec. maxLength: 400 type: string displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. \nIf left blank, the display name will be derived from the spec.\n" maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. maxLength: 255 minLength: 1 type: string iotDomainId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the digital twin model. enum: - ACTIVE - DELETED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' specUri: description: This is the DTMI (Digital Twin Model Identifier) of the digital twin model as defined in DTDL specification. maxLength: 128 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time when the resource was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time when the resource was last updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - iotDomainId - specUri - displayName - lifecycleState - timeCreated type: object ConfigureIotDomainDataAccessDetails: description: The configuration details for IoT Domain Data Access. discriminator: propertyName: type properties: type: description: configuration type enum: - DIRECT - ORDS - APEX type: string required: - type DigitalTwinRelationship: description: "A digital twin relationship represents an association between two digital twin instances. \nIt can include properties to describe the nature and context of the association within the IoT domain.\n\nTo use any API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. \nIf you are an administrator who needs to create policies to grant users access, see\n[Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).\n" properties: content: additionalProperties: type: object description: The value(s) of the relationship properties defined in the source digital twin model. maxProperties: 512 type: object contentPath: description: 'Its the name of the relationship that links two digital twin instances. Here, it is the relationship name of the source digital twin model. ' maxLength: 512 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A short description of the resource. ' maxLength: 400 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. maxLength: 255 minLength: 1 type: string iotDomainId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the digital twin relationship. enum: - ACTIVE - DELETED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' sourceDigitalTwinInstanceId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of source digital twin instance. ' maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetDigitalTwinInstanceId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of target digital twin instance. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time when the resource was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time when the resource was last updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - iotDomainId - contentPath - sourceDigitalTwinInstanceId - targetDigitalTwinInstanceId - displayName - lifecycleState - timeCreated type: object InvokeRawCommandDetails: description: Definition of unstructured command invocation payload discriminator: propertyName: requestDataFormat properties: requestDataFormat: description: 'data format: json, binary, text' enum: - TEXT - JSON - BINARY type: string requestDuration: description: Specified duration by which to send the request by. format: x-obmcs-duration type: string requestEndpoint: description: Device endpoint where request should be forwarded to. maximum: 255 type: string responseDuration: description: Specified duration by which to receive the response by. format: x-obmcs-duration type: string responseEndpoint: description: Device endpoint from which response is expected to come. type: string required: - requestDataFormat - requestEndpoint type: object CreateIotDomainGroupDetails: description: The information about new IoT domain group to be created. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment corresponding to the resource. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A short description of the resource. ' maxLength: 400 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: default: DEVELOPMENT description: "Type of domain group. DEVELOPMENT uses fewer resources and has a higher Recovery Time Objective (RTO),\nmaking it suitable for development and testing. PRODUCTION is recommended for production workloads. \nLIGHTWEIGHT and STANDARD are deprecated aliases for DEVELOPMENT and PRODUCTION respectively and will be removed \nin a future release.\n" enum: - PRODUCTION - DEVELOPMENT - STANDARD - LIGHTWEIGHT type: string required: - compartmentId type: object DataRetentionPeriodsInDays: description: Data Retention periods properties: historizedData: default: 30 description: Number of days for which any normalized data sent to IoT devices would be retained for. type: integer rawCommandData: default: 16 description: Number of days for which any raw command data sent to IoT devices would be retained for. type: integer rawData: default: 16 description: Number of days for which any raw data sent to IoT devices would be retained for. type: integer rejectedData: default: 16 description: Number of days for which any data sent to IoT devices would be retained for. type: integer required: - rawData - rejectedData - historizedData - rawCommandData type: object WorkRequestErrorCollection: description: A list of work request errors. Can contain both errors and other information, such as metadata. properties: items: description: A list of work request errors. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object DigitalTwinRelationshipSummary: description: Describes digital twin relationship summary properties: contentPath: description: 'Its the name of the relationship that links two digital twin instances. Here, it is the relationship name of the source digital twin model. ' maxLength: 512 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A short description of the resource. ' maxLength: 400 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. maxLength: 255 minLength: 1 type: string iotDomainId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the digital twin relationship. enum: - ACTIVE - DELETED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' sourceDigitalTwinInstanceId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of source digital twin instance. ' maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetDigitalTwinInstanceId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of target digital twin instance. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time when the resource was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time when the resource was last updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - iotDomainId - contentPath - sourceDigitalTwinInstanceId - targetDigitalTwinInstanceId - displayName - lifecycleState - timeCreated type: object ChangeIotDomainGroupCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment corresponding to the resource. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object CreateDigitalTwinAdapterDetails: description: 'The information about new digital twin adapter to be created. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A short description of the resource. ' maxLength: 400 type: string digitalTwinModelId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model. maxLength: 255 minLength: 1 type: string digitalTwinModelSpecUri: description: The URI of the digital twin model specification. maxLength: 128 minLength: 1 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object inboundEnvelope: $ref: '#/components/schemas/DigitalTwinAdapterInboundEnvelope' inboundRoutes: description: list of inbound routes items: $ref: '#/components/schemas/DigitalTwinAdapterInboundRoute' maxItems: 128 type: array iotDomainId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. maxLength: 255 minLength: 1 type: string required: - iotDomainId type: object CreateDigitalTwinModelDetails: description: The information about new digital twin model to be created. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A short description of the resource. If left blank, the description will be derived from the spec. maxLength: 400 type: string displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. \nIf left blank, the display name will be derived from the spec.\n" maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object iotDomainId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. maxLength: 255 minLength: 1 type: string spec: additionalProperties: type: object description: The specification of the digital twin model (DTDL). maxProperties: 512 type: object required: - iotDomainId - spec type: object WorkRequestLogEntryCollection: description: A list of work request logs. Can contain both logs and other information, such as metadata. properties: items: description: A list of work request log entries. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object parameters: DigitalTwinRelationshipSourceInstanceIdQueryParam: description: 'Filter resources that match the specified [OCID](/iaas/Content/General/Concepts/identifiers.htm) of source digital twin instance. ' in: query name: sourceDigitalTwinInstanceId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string DigitalTwinRelationshipTargetInstanceIdQueryParam: description: 'Filter resources that match the specified [OCID](/iaas/Content/General/Concepts/identifiers.htm) of target digital twin instance. ' in: query name: targetDigitalTwinInstanceId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 SortOrderQueryParam: description: Specifies sort order to use, either ASC (ascending) or DESC (descending). in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is ''DESC'' when sorting by time and ''ASC'' otherwise. ' schema: type: string enum: - ASC - DESC IotDomainLifecycleStateQueryParam: description: 'Filter resources whose lifecycleState matches the specified value. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/IotDomain/lifecycleState' schema: type: string IotDomainGroupIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an IoT Domain Group. in: path name: iotDomainGroupId required: true schema: type: string IotDomainGroupLifecycleStateQueryParam: description: Filter resources whose lifecycleState matches the specified value. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/IotDomainGroup/lifecycleState' schema: type: string RequestIdHeader: description: "Unique Oracle-assigned identifier for the request. \nIf you need to contact Oracle about a particular request, provide the request ID.\n" in: header name: opc-request-id schema: type: string LifecycleStateQueryParam: description: 'Filter resources whose lifecycleState matches the specified value. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/LifecycleState' schema: type: string enum: - ACTIVE - DELETED IotDomainIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. in: path name: iotDomainId required: true schema: type: string SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated ResourceIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request. in: query name: resourceId x-default-description: The OCID of the resource affected by the work request. schema: type: string DigitalTwinRelationshipIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of digital twin relationship. in: path name: digitalTwinRelationshipId required: true schema: type: string maxLength: 255 minLength: 1 WorkRequestStatusQueryParam: description: A filter to return only the resources that match the given lifecycle state. in: query name: status required: false x-default-description: Filters resources based on the specified lifecycle state. x-obmcs-top-level-enum: '#/definitions/OperationStatus' schema: type: string enum: - ACCEPTED - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED DigitalTwinModelIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of digital twin model. in: path name: digitalTwinModelId required: true schema: type: string maxLength: 255 minLength: 1 WorkRequestIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. in: path name: workRequestId required: true schema: type: string DigitalTwinAdapterIdentifierPathParam: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the digital twin adapter. ' in: path name: digitalTwinAdapterId required: true schema: type: string maxLength: 255 minLength: 1 DisplayNameQueryParam: description: 'Filter resources whose display name matches the specified value. ' in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 IdQueryParam: description: 'Filter resources by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be a valid OCID of the resource type. ' in: query name: id required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PaginationTokenQueryParam: description: 'For list pagination: The value of the opc-next-page response header from the previous "List" call. For important details on how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: page schema: type: string minLength: 1 WorkRequestIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. in: query name: id x-default-description: The OCID of the asynchronous work request. schema: type: string PaginationPageQueryParam: description: Page representing the requested page of items. in: query name: page schema: type: string maxLength: 512 minLength: 1 IotDomainGroupIdQueryParam: description: Filter resources that match the specified [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain group. in: query name: iotDomainGroupId required: false x-default-description: The OCID of the IoT domain group. schema: type: string maxLength: 255 minLength: 1 WorkRequestLogAndErrorSortByQueryParam: description: 'The field to sort by. Only one sort order can be specified. The default order for `timeCreated` is descending. ' in: query name: sortBy schema: type: string enum: - timeCreated default: timeCreated IotDomainGroupTypeQueryParam: description: Filter resources by type. Valid values are LIGHTWEIGHT or STANDARD. in: query name: type required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/IotDomainGroup/type' schema: type: string RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 DigitalTwinModelIdQueryParam: description: 'Filter resources that match the specified [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model. ' in: query name: digitalTwinModelId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 DigitalTwinInstanceIdentifierPathParam: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of digital twin instance. ' in: path name: digitalTwinInstanceId required: true schema: type: string maxLength: 255 minLength: 1 WorkRequestSortByQueryParam: description: 'The field to sort by. Only one sort order can be specified. Default order for `timeAccepted` is descending. ' in: query name: sortBy schema: type: string enum: - timeAccepted default: timeAccepted DigitalTwinModelSpecUriQueryParam: description: 'Filter resources that match the specified URI (DTMI) of the digital twin model. ' in: query name: digitalTwinModelSpecUri required: false x-default-description: 'null' x-example: dtmi:example:device;1 schema: type: string maxLength: 128 minLength: 1 CompartmentIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. in: query name: compartmentId required: true x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 DigitalTwinRelationshipContentPathQueryParam: description: 'Filters resources that match the content path of the digital twin relationship. ' in: query name: contentPath required: false x-default-description: 'null' schema: type: string maxLength: 512 minLength: 1 PaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: limit schema: type: integer default: 10 maximum: 100 minimum: 1 IncludeDigitalTwinInstanceContentMetadataQueryParam: description: If set to true , digital twin instance metadata is included in the response. in: query name: shouldIncludeMetadata required: false x-default-description: 'null' schema: type: boolean default: false DigitalTwinInstanceConnectivityTypeQueryParam: description: 'Filter resources whose connectivityType matches the specified value. ' in: query name: connectivityType required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/DigitalTwinInstanceConnectivityType' schema: type: string enum: - DIRECT - INDIRECT - GATEWAY - NONE DigitalTwinModelSpecUriStartsWithQueryParam: description: 'Filters resources by spec URI prefix. For example, to search all versions of the `dtmi:example:device;1` model, pass the prefix without the version: `dtmi:example:device`. ' in: query name: specUriStartsWith required: false x-default-description: 'null' x-example: dtmi:example:device schema: type: string maxLength: 128 minLength: 1 IotDomainIdQueryParam: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain in which to list digital twin resources. ' in: query name: iotDomainId required: true schema: type: string maxLength: 255 minLength: 1 responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' x-anchors: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-common-splat-settings: - allowCrossTenancy: true mode: automated - throttling: enableRegionalThrottling: true mode: default perTenantLimit: rpsLimit: 300 perUserLimit: rpmLimit: 600 rpsLimit: 50 x-downstream-splat-expressions: - downstream.invoke('iot-domain-resolver','GetResolution',request.parameter.iotDomainId,['type':'parent','isListOperation':true]).compartmentId - downstream.invoke('iot-domain-resolver','GetResolution',request.body.iotDomainId,['type':'parent','isListOperation':false]).compartmentId - downstream.getOr404('iot-domain-resolver','GetTeamBitResource',request.body.iotDomainId).teamBitId - downstream.invoke('iot-domain-resolver','GetResolution',request.resourceId,['type':'child','isListOperation':false]).compartmentId - splat.getTenancyId(request.body.compartmentId) - splat.getTenancyId(splat.getOrThrow(request.parameter.compartmentId, 'MissingParameter','compartmentId must be provided')) x-headers: null x-iot-digital-twin-adapter-properties: null x-iot-digital-twin-instance-properties: authId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance. maxLength: 255 minLength: 1 type: string externalKey: description: 'A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance. This could be a Bluetooth address, Ethernet MAC address, or serial number, depending on the use case. If not provided, the system will automatically generate one. ' maxLength: 64 minLength: 1 type: string gateways: description: 'An array of unique ids ([OCIDs](/iaas/Content/General/Concepts/identifiers.htm)) of the IoT digital twin instances with connectivityType equals to GATEWAY. ' items: maxLength: 255 minLength: 1 type: string minItems: 1 type: array x-iot-digital-twin-model-properties: description: description: A short description of the resource. If left blank, the description will be derived from the spec. maxLength: 400 type: string displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. \nIf left blank, the display name will be derived from the spec.\n" maxLength: 255 minLength: 1 type: string specUri: description: This is the DTMI (Digital Twin Model Identifier) of the digital twin model as defined in DTDL specification. maxLength: 128 minLength: 1 type: string x-iot-digital-twin-relationship-properties: content: additionalProperties: type: object description: The value(s) of the relationship properties defined in the source digital twin model. maxProperties: 512 type: object contentPath: description: 'Its the name of the relationship that links two digital twin instances. Here, it is the relationship name of the source digital twin model. ' maxLength: 512 minLength: 1 type: string sourceDigitalTwinInstanceId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of source digital twin instance. ' maxLength: 255 minLength: 1 type: string targetDigitalTwinInstanceId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of target digital twin instance. maxLength: 255 minLength: 1 type: string x-iot-domain-group-properties: dataHost: description: The host name of the database corresponding to the IoT Domain group. type: string dbAllowListedVcnIds: description: This is an array of VCN OCID (virtual cloud network Oracle Cloud ID) that is allowed to connect the data host. items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array dbConnectionString: description: The connection string used to connect to the data host associated with the IoT domain group. type: string dbTokenScope: description: The token scope used to connect to the data host associated with the IoT domain group. maxLength: 275 minLength: 1 type: string type: default: DEVELOPMENT description: "Type of domain group. DEVELOPMENT uses fewer resources and has a higher Recovery Time Objective (RTO),\nmaking it suitable for development and testing. PRODUCTION is recommended for production workloads. \nLIGHTWEIGHT and STANDARD are deprecated aliases for DEVELOPMENT and PRODUCTION respectively and will be removed \nin a future release.\n" enum: - PRODUCTION - DEVELOPMENT - STANDARD - LIGHTWEIGHT type: string x-iot-domain-properties: dataRetentionPeriodInDays: description: The duration (in days) for which data will be retained in the IoT domain. minimum: 16 type: integer dbAllowListedIdentityGroupNames: description: List of IAM groups of form described in [here](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/mnqmn/#GUID-3634D6C9-A7F1-4875-9925-BAEA2D3C5197) that are allowed to directly connect to the data host. items: type: string maxItems: 5 type: array dbAllowedIdentityDomainHost: description: Host name of identity domain that is used for authenticating connect to data host via ORDS. type: string dbWorkspaceAdminInitialPassword: description: Initial admin password for APEX workspace associated with the IoT domain. format: password maxLength: 30 minLength: 12 type: string deviceHost: description: Host name of an IoT domain, where IoT devices can connect to. type: string x-properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment corresponding to the resource. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A short description of the resource. ' maxLength: 400 type: string digitalTwinAdapterId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the digital twin adapter. maxLength: 255 minLength: 1 type: string digitalTwinModelId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model. maxLength: 255 minLength: 1 type: string digitalTwinModelSpecUri: description: The URI of the digital twin model specification. maxLength: 128 minLength: 1 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. maxLength: 255 minLength: 1 type: string iotDomainGroupId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain group. maxLength: 255 minLength: 1 type: string iotDomainId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time when the resource was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time when the resource was last updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.iot