Retrieve Device Models
get
/iot/api/v2/deviceModels
List Device Models
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.
-
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
Sorting order in the following format: field[:asc|desc]{,field[:asc|desc]} Default order for each field is ascending.
-
q(optional): string
Query according to the MongoDB syntax (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:
Show Source
object
-
count:
integer(int32)
-
hasMore:
boolean
-
items:
array items
-
limit:
integer(int32)
-
links:
array links
The set of API navigation links.
-
offset:
integer(int32)
Nested Schema : items
Type:
Show Source
object
-
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
Nested Schema : DeviceModelActionModel_receive
Type:
Show Source
object
-
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
Nested Schema : DeviceModelActionArgumentModel_receive
Type:
Show Source
object
-
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].
Nested Schema : DeviceModelAttributeModel_receive
Type:
Show Source
object
-
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
Nested Schema : MessageFormatModel_receive
Type:
Show Source
object
-
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
Nested Schema : MessageFormatValue_receive
Type:
Show Source
object
-
fields:
array fields
Property description was not set
Nested Schema : MessageFormatField_receive
Type:
Show Source
object
-
name:
string
Property description was not set
-
optional:
boolean
Property description was not set
-
type:
string
One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
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.
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.
Examples
curl -X GET
-u <username>:<password>
-H 'Accept: application/json'
https://iotserver/iot/api/v2/deviceModels
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"items":[
{
"urn":"urn:example:unique:identifier:of:the:resource:2cf",
"name":"Human friendly name of the device model",
"description":"Optional description of the device model",
"system":false,
"draft":false,
"created":1469184297746,
"createdAsString":"2016-07-22T10:44:57.746Z",
"lastModified":1469184297746,
"lastModifiedAsString":"2016-07-22T10:44:57.746Z",
"userLastModified":"Name of the user who last to modify this device model",
"attributes":[
{
"range":"For NUMBERs and INTEGERs only, defines the acceptable range of values such as '1,10'. This range is inclusive.",
"alias":"Optional alternative name. This property is deprecated and should not be used for new or updated device models.",
"writable":false,
"description":"A human friendly description",
"name":"A name for the attribute. Name can contain only A-Z, a-z, 0-9 or underscore (_) characters.",
"type":"The data typeOne of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI]."
}
],
"actions":[
{
"argType":"If it is specified, then there is a single required argument. If neither this nor arguments field is present, then action has no arguments. Is not allowed when arguments field is specified.One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].",
"range":"For NUMBERs and INTEGERs only, defines the acceptable range of values such as '1,10'. This range is inclusive. Is not allowed when arguments field is specified.",
"alias":"Optional alternative name. This property is deprecated and should not be used for new or updated device models.",
"description":"A human friendly description",
"arguments":[
{
"range":"For NUMBERs and INTEGERs only, defines the acceptable range of values such as '1,10'. This range is inclusive.",
"description":"A human friendly description",
"name":"A name for the action",
"type":"Argument type.One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI]."
}
],
"name":"A name for the action"
}
],
"formats":[
{
"urn":"urn:example:unique:identifier:of:the:resource:2e45",
"name":"Message format name",
"description":"Message format description",
"type":"Message format typeOne of [DATA, ALERT, EXPLORATION, EXPLORATION_DATA, EXPLORATION_ALERT, IACS_DATA, IACS_ALERT].",
"deviceModel":"Device model that created this message format",
"value":{
"fields":[
{
"optional":false,
"name":"Name of the message format field. Name can contain only A-Z, a-z, 0-9 or underscore (_) characters.",
"type":"Type of the message format fieldOne of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI]."
}
]
},
"explorationID":"ID of an exploration assocoated with the message format",
"severity":"The severity of exploration's alert message format",
"sourceType":"Type of the source from which format was createdOne of [UNKNOWN, DEVICE_MODEL, EXPLORATION, ANALYTICS].",
"sourceId":"337f2bc24cbb-4753"
}
],
"devicePolicies":{
"links":[
{
"rel":"self",
"href":"https://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"https://iotserver/iot/api/version/resource/path"
}
]
}
},
{
"urn":"urn:example:unique:identifier:of:the:resource:7041",
"name":"Human friendly name of the device model",
"description":"Optional description of the device model",
"system":false,
"draft":false,
"created":1469184297746,
"createdAsString":"2016-07-22T10:44:57.746Z",
"lastModified":1469184297746,
"lastModifiedAsString":"2016-07-22T10:44:57.746Z",
"userLastModified":"Name of the user who last to modify this device model",
"attributes":[
{
"range":"For NUMBERs and INTEGERs only, defines the acceptable range of values such as '1,10'. This range is inclusive.",
"alias":"Optional alternative name. This property is deprecated and should not be used for new or updated device models.",
"writable":false,
"description":"A human friendly description",
"name":"A name for the attribute. Name can contain only A-Z, a-z, 0-9 or underscore (_) characters.",
"type":"The data typeOne of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI]."
}
],
"actions":[
{
"argType":"If it is specified, then there is a single required argument. If neither this nor arguments field is present, then action has no arguments. Is not allowed when arguments field is specified.One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI].",
"range":"For NUMBERs and INTEGERs only, defines the acceptable range of values such as '1,10'. This range is inclusive. Is not allowed when arguments field is specified.",
"alias":"Optional alternative name. This property is deprecated and should not be used for new or updated device models.",
"description":"A human friendly description",
"arguments":[
{
"range":"For NUMBERs and INTEGERs only, defines the acceptable range of values such as '1,10'. This range is inclusive.",
"description":"A human friendly description",
"name":"A name for the action",
"type":"Argument type.One of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI]."
}
],
"name":"A name for the action"
}
],
"formats":[
{
"urn":"urn:example:unique:identifier:of:the:resource:7051",
"name":"Message format name",
"description":"Message format description",
"type":"Message format typeOne of [DATA, ALERT, EXPLORATION, EXPLORATION_DATA, EXPLORATION_ALERT, IACS_DATA, IACS_ALERT].",
"deviceModel":"Device model that created this message format",
"value":{
"fields":[
{
"optional":false,
"name":"Name of the message format field. Name can contain only A-Z, a-z, 0-9 or underscore (_) characters.",
"type":"Type of the message format fieldOne of [STRING, NUMBER, BOOLEAN, INTEGER, DATETIME, URI]."
}
]
},
"explorationID":"ID of an exploration assocoated with the message format",
"severity":"The severity of exploration's alert message format",
"sourceType":"Type of the source from which format was createdOne of [UNKNOWN, DEVICE_MODEL, EXPLORATION, ANALYTICS].",
"sourceId":"6656c7cb44-5228"
}
],
"devicePolicies":{
"links":[
{
"rel":"self",
"href":"https://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"https://iotserver/iot/api/version/resource/path"
}
]
}
}
],
"links":[
{
"rel":"self",
"href":"https://iotserver/iot/api/version/resource/path"
},
{
"rel":"canonical",
"href":"https://iotserver/iot/api/version/resource/path"
}
],
"count":2,
"limit":10,
"offset":0,
"hasMore":false
}
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/deviceModels
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.