REST API for Oracle Internet of Things Cloud Service

Retrieve Information about Multiple Device Models Consumed by The Application

get

/iot/api/v2/apps/{app-id}/deviceModels

Retrieve a Collection of Device Model records that are consumed by an Application

Request

Path Parameters

app-id: string

Unique identifier of the application

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.
limit(optional): integer

The maximum number of entries to return to the end user.
offset(optional): integer

The number that the first record of results is starting from.
orderBy(optional): string

Ordering criteria for the returned Device Models list
q(optional): string

Query to filter Device Models consumed by the Application (For more information on mongoDB query parameters refer to Using mongoDB Query Syntax.)
since(optional): integer

The starting point of the desired time interval, in milliseconds. The default is 0.
totalResults(optional): boolean

The total number of results suiting the request.
until(optional): integer

The finishing point of the desired time interval, in milliseconds. The default is 0.

Response

Supported Media Types

application/json
application/vnd.oracle.resource+json;type=collection

200 Response

Successfully processed.

Root Schema : DeviceModelImpl_receive_list

Type: object

Show Source

count: integer(int32)
hasMore: boolean
items: array items
limit: integer(int32)
links: array links

The set of API navigation links.
offset: integer(int32)

{
    "properties":{
        "count":{
            "format":"int32",
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "items":{
            "items":{
                "properties":{
                    "actions":{
                        "description":"Property description was not set",
                        "items":{
                            "$ref":"#/definitions/DeviceModelActionModel_receive"
                        },
                        "type":"array"
                    },
                    "attributes":{
                        "description":"Property description was not set",
                        "items":{
                            "$ref":"#/definitions/DeviceModelAttributeModel_receive"
                        },
                        "type":"array"
                    },
                    "created":{
                        "description":"Property description was not set",
                        "type":"integer"
                    },
                    "createdAsDate":{
                        "description":"Property description was not set",
                        "type":"integer"
                    },
                    "description":{
                        "description":"Property description was not set",
                        "type":"string"
                    },
                    "draft":{
                        "description":"Property description was not set",
                        "type":"boolean"
                    },
                    "formatObjects":{
                        "description":"Property description was not set",
                        "items":{
                            "$ref":"#/definitions/MessageFormatModel_receive"
                        },
                        "type":"array"
                    },
                    "lastModified":{
                        "description":"Property description was not set",
                        "type":"integer"
                    },
                    "lastModifiedAsDate":{
                        "description":"Property description was not set",
                        "type":"integer"
                    },
                    "name":{
                        "description":"Property description was not set",
                        "type":"string"
                    },
                    "system":{
                        "description":"Property description was not set",
                        "type":"boolean"
                    },
                    "uRN":{
                        "description":"Property description was not set",
                        "type":"string"
                    },
                    "userLastModified":{
                        "description":"Property description was not set",
                        "type":"string"
                    }
                },
                "required":[
                    "createdAsDate",
                    "formatObjects",
                    "lastModifiedAsDate",
                    "uRN",
                    "draft",
                    "userLastModified",
                    "created",
                    "system",
                    "lastModified",
                    "name",
                    "actions",
                    "attributes",
                    "description"
                ],
                "type":"object"
            },
            "type":"array"
        },
        "limit":{
            "format":"int32",
            "type":"integer"
        },
        "links":{
            "description":"The set of API navigation links.",
            "items":{
                "properties":{
                    "href":{
                        "description":"The target resource URI",
                        "example":"https://iotserver/iot/api/vX/some/API/path",
                        "type":"string"
                    },
                    "rel":{
                        "description":"Relation type",
                        "example":"canonical",
                        "type":"string"
                    }
                },
                "type":"object"
            },
            "type":"array"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        }
    },
    "required":[
        "items",
        "links",
        "limit",
        "offset",
        "count",
        "hasMore"
    ],
    "type":"object"
}

Nested Schema : items

Type: array

Show Source

Array of: object items

{
    "items":{
        "properties":{
            "actions":{
                "description":"Property description was not set",
                "items":{
                    "$ref":"#/definitions/DeviceModelActionModel_receive"
                },
                "type":"array"
            },
            "attributes":{
                "description":"Property description was not set",
                "items":{
                    "$ref":"#/definitions/DeviceModelAttributeModel_receive"
                },
                "type":"array"
            },
            "created":{
                "description":"Property description was not set",
                "type":"integer"
            },
            "createdAsDate":{
                "description":"Property description was not set",
                "type":"integer"
            },
            "description":{
                "description":"Property description was not set",
                "type":"string"
            },
            "draft":{
                "description":"Property description was not set",
                "type":"boolean"
            },
            "formatObjects":{
                "description":"Property description was not set",
                "items":{
                    "$ref":"#/definitions/MessageFormatModel_receive"
                },
                "type":"array"
            },
            "lastModified":{
                "description":"Property description was not set",
                "type":"integer"
            },
            "lastModifiedAsDate":{
                "description":"Property description was not set",
                "type":"integer"
            },
            "name":{
                "description":"Property description was not set",
                "type":"string"
            },
            "system":{
                "description":"Property description was not set",
                "type":"boolean"
            },
            "uRN":{
                "description":"Property description was not set",
                "type":"string"
            },
            "userLastModified":{
                "description":"Property description was not set",
                "type":"string"
            }
        },
        "required":[
            "createdAsDate",
            "formatObjects",
            "lastModifiedAsDate",
            "uRN",
            "draft",
            "userLastModified",
            "created",
            "system",
            "lastModified",
            "name",
            "actions",
            "attributes",
            "description"
        ],
        "type":"object"
    },
    "type":"array"
}

Nested Schema : links

Type: array

The set of API navigation links.

Show Source

Array of: object items

{
    "description":"The set of API navigation links.",
    "items":{
        "properties":{
            "href":{
                "description":"The target resource URI",
                "example":"https://iotserver/iot/api/vX/some/API/path",
                "type":"string"
            },
            "rel":{
                "description":"Relation type",
                "example":"canonical",
                "type":"string"
            }
        },
        "type":"object"
    },
    "type":"array"
}

Nested Schema : items

Type: object

Show Source

actions: array actions

Property description was not set
attributes: array attributes

Property description was not set
created: integer

Property description was not set
createdAsDate: integer

Property description was not set
description: string

Property description was not set
draft: boolean

Property description was not set
formatObjects: array formatObjects

Property description was not set
lastModified: integer

Property description was not set
lastModifiedAsDate: integer

Property description was not set
name: string

Property description was not set
system: boolean

Property description was not set
uRN: string

Property description was not set
userLastModified: string

Property description was not set

{
    "properties":{
        "actions":{
            "description":"Property description was not set",
            "items":{
                "$ref":"#/definitions/DeviceModelActionModel_receive"
            },
            "type":"array"
        },
        "attributes":{
            "description":"Property description was not set",
            "items":{
                "$ref":"#/definitions/DeviceModelAttributeModel_receive"
            },
            "type":"array"
        },
        "created":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "createdAsDate":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "description":{
            "description":"Property description was not set",
            "type":"string"
        },
        "draft":{
            "description":"Property description was not set",
            "type":"boolean"
        },
        "formatObjects":{
            "description":"Property description was not set",
            "items":{
                "$ref":"#/definitions/MessageFormatModel_receive"
            },
            "type":"array"
        },
        "lastModified":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "lastModifiedAsDate":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "name":{
            "description":"Property description was not set",
            "type":"string"
        },
        "system":{
            "description":"Property description was not set",
            "type":"boolean"
        },
        "uRN":{
            "description":"Property description was not set",
            "type":"string"
        },
        "userLastModified":{
            "description":"Property description was not set",
            "type":"string"
        }
    },
    "required":[
        "createdAsDate",
        "formatObjects",
        "lastModifiedAsDate",
        "uRN",
        "draft",
        "userLastModified",
        "created",
        "system",
        "lastModified",
        "name",
        "actions",
        "attributes",
        "description"
    ],
    "type":"object"
}

Nested Schema : actions

Type: array

Property description was not set

Show Source

Array of: object DeviceModelActionModel_receive

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

Nested Schema : attributes

Type: array

Property description was not set

Show Source

Array of: object DeviceModelAttributeModel_receive

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

Nested Schema : formatObjects

Type: array

Property description was not set

Show Source

Array of: object MessageFormatModel_receive

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

Nested Schema : DeviceModelActionModel_receive

Type: object

Show Source

alias: string

Property description was not set
argType: string

One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].
arguments: array arguments

Property description was not set
description: string

Property description was not set
name: string

Property description was not set
range: string

Property description was not set

{
    "properties":{
        "alias":{
            "description":"Property description was not set",
            "type":"string"
        },
        "argType":{
            "description":"One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].",
            "type":"string"
        },
        "arguments":{
            "description":"Property description was not set",
            "items":{
                "$ref":"#/definitions/DeviceModelActionArgumentModel_receive"
            },
            "type":"array"
        },
        "description":{
            "description":"Property description was not set",
            "type":"string"
        },
        "name":{
            "description":"Property description was not set",
            "type":"string"
        },
        "range":{
            "description":"Property description was not set",
            "type":"string"
        }
    },
    "required":[
        "argType",
        "range",
        "alias",
        "name",
        "description",
        "arguments"
    ],
    "type":"object"
}

Nested Schema : arguments

Type: array

Property description was not set

Show Source

Array of: object DeviceModelActionArgumentModel_receive

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

Nested Schema : DeviceModelActionArgumentModel_receive

Type: object

Show Source

description: string

Property description was not set
name: string

Property description was not set
range: string

Property description was not set
type: string

One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].

{
    "properties":{
        "description":{
            "description":"Property description was not set",
            "type":"string"
        },
        "name":{
            "description":"Property description was not set",
            "type":"string"
        },
        "range":{
            "description":"Property description was not set",
            "type":"string"
        },
        "type":{
            "description":"One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].",
            "type":"string"
        }
    },
    "required":[
        "range",
        "name",
        "type",
        "description"
    ],
    "type":"object"
}

Nested Schema : DeviceModelAttributeModel_receive

Type: object

Show Source

alias: string

Property description was not set
description: string

Property description was not set
name: string

Property description was not set
range: string

Property description was not set
type: string

One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].
writable: boolean

Property description was not set

{
    "properties":{
        "alias":{
            "description":"Property description was not set",
            "type":"string"
        },
        "description":{
            "description":"Property description was not set",
            "type":"string"
        },
        "name":{
            "description":"Property description was not set",
            "type":"string"
        },
        "range":{
            "description":"Property description was not set",
            "type":"string"
        },
        "type":{
            "description":"One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].",
            "type":"string"
        },
        "writable":{
            "description":"Property description was not set",
            "type":"boolean"
        }
    },
    "required":[
        "range",
        "alias",
        "writable",
        "name",
        "type",
        "description"
    ],
    "type":"object"
}

Nested Schema : MessageFormatModel_receive

Type: object

Show Source

description: string

Property description was not set
deviceModel: string

Property description was not set
explorationId: string

Property description was not set
name: string

Property description was not set
severity: string

Property description was not set
sourceId: string

Property description was not set
sourceType: string

One of [UNKNOWN, DEVICE_MODEL, EXPLORATION, ANALYTICS].
type: string

One of [DATA, ALERT, EXPLORATION, EXPLORATION_DATA, EXPLORATION_ALERT, IACS_DATA, IACS_ALERT].
uRN: string

Property description was not set
value: object MessageFormatValue_receive

{
    "properties":{
        "description":{
            "description":"Property description was not set",
            "type":"string"
        },
        "deviceModel":{
            "description":"Property description was not set",
            "type":"string"
        },
        "explorationId":{
            "description":"Property description was not set",
            "type":"string"
        },
        "name":{
            "description":"Property description was not set",
            "type":"string"
        },
        "severity":{
            "description":"Property description was not set",
            "type":"string"
        },
        "sourceId":{
            "description":"Property description was not set",
            "type":"string"
        },
        "sourceType":{
            "description":"One of [UNKNOWN, DEVICE_MODEL, EXPLORATION, ANALYTICS].",
            "type":"string"
        },
        "type":{
            "description":"One of [DATA, ALERT, EXPLORATION, EXPLORATION_DATA, EXPLORATION_ALERT, IACS_DATA, IACS_ALERT].",
            "type":"string"
        },
        "uRN":{
            "description":"Property description was not set",
            "type":"string"
        },
        "value":{
            "$ref":"#/definitions/MessageFormatValue_receive"
        }
    },
    "required":[
        "deviceModel",
        "explorationId",
        "sourceId",
        "uRN",
        "sourceType",
        "severity",
        "name",
        "value",
        "type",
        "description"
    ],
    "type":"object"
}

Nested Schema : MessageFormatValue_receive

Type: object

Show Source

fields: array fields

Property description was not set

{
    "properties":{
        "fields":{
            "description":"Property description was not set",
            "items":{
                "$ref":"#/definitions/MessageFormatField_receive"
            },
            "type":"array"
        }
    },
    "required":[
        "fields"
    ],
    "type":"object"
}

Nested Schema : fields

Type: array

Property description was not set

Show Source

Array of: object MessageFormatField_receive

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

Nested Schema : MessageFormatField_receive

Type: object

Show Source

name: string

Property description was not set
optional: boolean

Property description was not set
type: string

One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].

{
    "properties":{
        "name":{
            "description":"Property description was not set",
            "type":"string"
        },
        "optional":{
            "description":"Property description was not set",
            "type":"boolean"
        },
        "type":{
            "description":"One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].",
            "type":"string"
        }
    },
    "required":[
        "name",
        "type",
        "optional"
    ],
    "type":"object"
}

Nested Schema : items

Type: object

Show Source

href(optional): string

The target resource URI

Example: https://iotserver/iot/api/vX/some/API/path
rel(optional): string

Relation type

Example: canonical

{
    "properties":{
        "href":{
            "description":"The target resource URI",
            "example":"https://iotserver/iot/api/vX/some/API/path",
            "type":"string"
        },
        "rel":{
            "description":"Relation type",
            "example":"canonical",
            "type":"string"
        }
    },
    "type":"object"
}

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.

406 Response

Request Not Acceptable. The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.