REST API for Oracle Internet of Things Cloud Service

Retrieve the Details of an Import Request

get

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

Returns the import request by specified ID.

Request

Path Parameters

request-id: string

ID of the import request

Query Parameters

expand(optional): string

The list of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
fields(optional): string

The comma-separated list of fields to be shown in response. By default all response object fields will be present.

Response

Supported Media Types

application/json

200 Response

Successfully processed.

Root Schema : ImportRequestImpl_receive

Type: object

Show Source

completed: integer

Date of the request completion in milliseconds since January 1, 1970
completedAsString: string

Date of the request completion represented as ISO string.
content: object ConflictReport_receive
created: integer

Date of the request creation in milliseconds since January 1, 1970
createdAsString: string

Date of the request creation represented as ISO string.
description: string

Import request description.
id: string

Unique identifier that identifies the import request.
lastModifiedBy: string

Name of the user who last modified(created/completed) this request.
status: string

The state associated with the request.One of [CREATED, VERIFIED, CONFLICT, RUNNING, COMPLETED, FAILED].

{
    "type":"object",
    "required":[
        "id",
        "status",
        "description",
        "lastModifiedBy",
        "created",
        "createdAsString",
        "completed",
        "completedAsString",
        "content"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier that identifies the import request."
        },
        "status":{
            "type":"string",
            "description":"The state associated with the request.One of [CREATED, VERIFIED, CONFLICT, RUNNING, COMPLETED, FAILED]."
        },
        "description":{
            "type":"string",
            "description":"Import request description."
        },
        "lastModifiedBy":{
            "type":"string",
            "description":"Name of the user who last modified(created/completed) this request."
        },
        "created":{
            "type":"integer",
            "description":"Date of the request creation in milliseconds since January 1, 1970"
        },
        "createdAsString":{
            "type":"string",
            "description":"Date of the request creation represented as ISO string."
        },
        "completed":{
            "type":"integer",
            "description":"Date of the request completion in milliseconds since January 1, 1970"
        },
        "completedAsString":{
            "type":"string",
            "description":"Date of the request completion represented as ISO string."
        },
        "content":{
            "$ref":"#/definitions/ConflictReport_receive"
        }
    }
}

Nested Schema : ConflictReport_receive

Type: object

Show Source

applications: array applications

Application part of the report
deviceModels: array deviceModels

Device model part of the report
settings: array settings

Setting part of the report

{
    "type":"object",
    "required":[
        "applications",
        "deviceModels",
        "settings"
    ],
    "properties":{
        "applications":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ConflictReportImpl$ApplicationItem_receive"
            },
            "description":"Application part of the report"
        },
        "deviceModels":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ConflictReportImpl$DeviceModelItem_receive"
            },
            "description":"Device model part of the report"
        },
        "settings":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ConflictReportImpl$SettingItem_receive"
            },
            "description":"Setting part of the report"
        }
    }
}

Nested Schema : applications

Type: array

Application part of the report

Show Source

Array of: object ConflictReportImpl$ApplicationItem_receive

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ConflictReportImpl$ApplicationItem_receive"
    },
    "description":"Application part of the report"
}

Nested Schema : deviceModels

Type: array

Device model part of the report

Show Source

Array of: object ConflictReportImpl$DeviceModelItem_receive

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ConflictReportImpl$DeviceModelItem_receive"
    },
    "description":"Device model part of the report"
}

Nested Schema : settings

Type: array

Setting part of the report

Show Source

Array of: object ConflictReportImpl$SettingItem_receive

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ConflictReportImpl$SettingItem_receive"
    },
    "description":"Setting part of the report"
}

Nested Schema : ConflictReportImpl$ApplicationItem_receive

Type: object

Show Source

conflicts: object AppConflicts_receive
id: string

Unique identifier of the application
name: string

Application name

{
    "type":"object",
    "required":[
        "id",
        "name",
        "conflicts"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the application"
        },
        "name":{
            "type":"string",
            "description":"Application name"
        },
        "conflicts":{
            "$ref":"#/definitions/AppConflicts_receive"
        }
    }
}

Nested Schema : AppConflicts_receive

Type: object

Show Source

conflictItems: object conflictItems

Additional Properties Allowed: additionalProperties

Property description was not set
genericConflicts: array genericConflicts

Property description was not set

{
    "type":"object",
    "required":[
        "conflictItems",
        "genericConflicts"
    ],
    "properties":{
        "conflictItems":{
            "type":"object",
            "additionalProperties":{
                "type":"string",
                "description":"A map of the following type: Map&lt;String, String&gt;"
            },
            "properties":{
            },
            "description":"Property description was not set"
        },
        "genericConflicts":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ConflictReportImpl$ConflictItem_receive"
            },
            "description":"Property description was not set"
        }
    }
}

Nested Schema : conflictItems

Type: object

Additional Properties Allowed

Show Source

string

A map of the following type: Map<String, String>

{
    "type":"object",
    "additionalProperties":{
        "type":"string",
        "description":"A map of the following type: Map&lt;String, String&gt;"
    },
    "properties":{
    },
    "description":"Property description was not set"
}

Property description was not set

Show Source

{
    "type":"object",
    "additionalProperties":{
        "type":"string",
        "description":"A map of the following type: Map&lt;String, String&gt;"
    },
    "properties":{
    },
    "description":"Property description was not set"
}

Nested Schema : genericConflicts

Type: array

Property description was not set

Show Source

Array of: object ConflictReportImpl$ConflictItem_receive

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ConflictReportImpl$ConflictItem_receive"
    },
    "description":"Property description was not set"
}

Nested Schema : ConflictReportImpl$ConflictItem_receive

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : ConflictReportImpl$DeviceModelItem_receive

Type: object

Show Source

conflict: object ConflictItem_receive
name: string

Device model name
urn: string

Device model URN

{
    "type":"object",
    "required":[
        "urn",
        "name",
        "conflict"
    ],
    "properties":{
        "urn":{
            "type":"string",
            "description":"Device model URN"
        },
        "name":{
            "type":"string",
            "description":"Device model name"
        },
        "conflict":{
            "$ref":"#/definitions/ConflictItem_receive"
        }
    }
}

Nested Schema : ConflictItem_receive

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : ConflictReportImpl$SettingItem_receive

Type: object

Show Source

conflicts: array conflicts

List of conflicts for the setting
group: string

Group name of the setting
name: string

Setting name

{
    "type":"object",
    "required":[
        "group",
        "name",
        "conflicts"
    ],
    "properties":{
        "group":{
            "type":"string",
            "description":"Group name of the setting"
        },
        "name":{
            "type":"string",
            "description":"Setting name"
        },
        "conflicts":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ConflictReportImpl$ConflictItem_receive"
            },
            "description":"List of conflicts for the setting"
        }
    }
}

Nested Schema : conflicts

Type: array

List of conflicts for the setting

Show Source

Array of: object ConflictReportImpl$ConflictItem_receive

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ConflictReportImpl$ConflictItem_receive"
    },
    "description":"List of conflicts for the setting"
}

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.

Examples

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

Example of Response Body

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


{
    "id":"28503b772dea-279e",
    "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":"1c2f252b9c-3fb7",
                "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:1c82",
                "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 GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/iot/api/v2/imports/158629854c02-56f1

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.