1. REST API for Oracle Internet of Things Cloud Service
  2. Tasks
  3. Import

Execute an Import Request

post

/iot/api/v2/imports/{request-id}

Executes the specified import request in accordance with the 'Import Rule' (the second phase of the protocol).

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : ImportConfigurationImpl_receive
Type: object
Show Source
Nested Schema : ApplicationSet_receive
Type: object
Show Source
  • The default resolution method.One of [SKIP, OVERRIDE, APPEND].
Nested Schema : DeviceModelSet_receive
Type: object
Show Source
  • The default resolution method.One of [SKIP, OVERRIDE, APPEND].
Nested Schema : settings
Type: array
This optional object specifies how to resolve conflicts during settings import.
Show Source
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : ImportRequestImpl_receive
Type: object
Show Source
Nested Schema : ConflictReport_receive
Type: object
Show Source
Nested Schema : applications
Type: array
Application part of the report
Show Source
Nested Schema : deviceModels
Type: array
Device model part of the report
Show Source
Nested Schema : settings
Type: array
Setting part of the report
Show Source
Nested Schema : ConflictReportImpl$ApplicationItem_receive
Type: object
Show Source
Nested Schema : AppConflicts_receive
Type: object
Show Source
Nested Schema : conflictItems
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : genericConflicts
Type: array
Property description was not set
Show Source
Nested Schema : ConflictReportImpl$ConflictItem_receive
Type: object
Show Source
Nested Schema : ConflictReportImpl$DeviceModelItem_receive
Type: object
Show Source
Nested Schema : ConflictItem_receive
Type: object
Show Source
Nested Schema : ConflictReportImpl$SettingItem_receive
Type: object
Show Source
Nested Schema : conflicts
Type: array
List of conflicts for the setting
Show Source

400 Response

Bad Request. The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

401 Response

Unauthorized. The request requires user authentication.

403 Response

Forbidden. The server understood the request, but is refusing to fulfill it. Authorization will not help and the request SHOULD NOT be repeated.

404 Response

Not Found. The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.

409 Response

Conflict. The request could not be completed due to a conflict with the current state of the resource. This code is only allowed in situations where it is expected that the user might be able to resolve the conflict and resubmit the request.
Back to Top

Examples

curl -X POST 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   -H 'Content-Type: application/json' 
   https://iotserver/iot/api/v2/imports/{request-id}

Example of Request Body

The following example shows the content of the request body in JSON format:


{
    "applications":{
        "*":"The default resolution method.One of [SKIP, OVERRIDE, APPEND]."
    },
    "deviceModels":{
        "*":"The default resolution method.One of [SKIP, OVERRIDE, APPEND]."
    },
    "settings":[
        "settings_1",
        "settings_2",
        "settings_3"
    ]
}

Example of Response Body

The following example shows the content of the response body in JSON format:


{
    "id":"4bc436cf71e2-4eb9",
    "status":"The state associated with the request.One of [CREATED, VERIFIED, CONFLICT, RUNNING, COMPLETED, FAILED].",
    "description":"Import request description.",
    "lastModifiedBy":"Name of the user who last modified(created/completed) this request.",
    "created":1469184297746,
    "createdAsString":"2016-07-22T10:44:57.746Z",
    "completed":12345,
    "completedAsString":"Date of the request completion represented as ISO string.",
    "content":{
        "applications":[
            {
                "id":"4cdeb3144ea-6467",
                "name":"Application name",
                "conflicts":{
                    "conflictItems":{
                        "conflictItems_key1":"conflictItems_value1",
                        "conflictItems_key2":"conflictItems_value2",
                        "conflictItems_key3":"conflictItems_value3"
                    }
                }
            }
        ],
        "deviceModels":[
            {
                "urn":"urn:example:unique:identifier:of:the:resource:51fc",
                "name":"Device model name",
                "conflict":{
                }
            }
        ],
        "settings":[
            {
                "group":"Group name of the setting",
                "name":"Setting name"
            }
        ]
    }
}



Complete cURL Example

The following example shows a complete cURL command that you can use to perform the described operation:

curl -X POST 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   -H 'Content-Type: application/json'  
   -d '{"applications":{"*":"The default resolution method.One of [SKIP, OVERRIDE, APPEND]."},"deviceModels":{"*":"The default resolution method.One of [SKIP, OVERRIDE, APPEND]."},"settings":["settings_1","settings_2","settings_3"]}'
   https://iotserver/iot/api/v2/imports/5fea144f56ad-56c8



Note that in the request, https://iotserver will be replaced by the name and port of your assigned IoT Cloud Service instance. The format of the Cloud Service instance is https://myinstance-myidentitydomain.iot.us.oraclecloud.com and the default port is 443.
Back to Top