Retrieve Information about Devices that Participate in an Application
get
/iot/api/v2/apps/{app-id}/devices
Retrieve a collection of Devices records. The devices that participate in an application is intersection of following two sets of devices
- All the devices that implement at least one of the device models consumed by the app All the devices that are members of at least one device group created for the app
If there is no device selection criteria specified for the device selection group/s for the app, then basically all the devices corresponding to all the device models that the app consumes would be returned for the API
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 Devices list
-
q(optional): string
Query to filter Devices (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 : DeviceImpl_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-
childrenDevices:
object childrenDevices
Property description was not set
-
connectivityStatus:
object ConnectivityStatus_receive
-
created:
integer
Property description was not set
-
createdAsLong:
integer
Property description was not set
-
description:
string
Property description was not set
-
deviceModels:
array deviceModels
Property description was not set
-
deviceType:
string
One of [UNKNOWN, GATEWAY, DIRECTLY_CONNECTED_DEVICE, INDIRECTLY_CONNECTED_DEVICE].
-
deviceUID:
string
Property description was not set
-
directlyConnectedOwner:
object directlyConnectedOwner
-
enabled:
boolean
Property description was not set
-
endpointId:
string
Property description was not set
-
endpointName:
string
Property description was not set
-
enrollmentTime:
integer
Property description was not set
-
enrollmentTimeAsLong:
integer
Property description was not set
-
hardwareRevision:
string
Property description was not set
-
lastHeardTime:
integer
Property description was not set
-
lifecycleState:
string
One of [REGISTERED, ACTIVATED, ENABLED, DISABLED, DECOMMISSIONED, UNKNOWN].
-
location:
object location
-
logs:
object Logs_receive
-
manufacturer:
string
Property description was not set
-
metadata:
object metadata
Property description was not set
-
modelNumber:
string
Property description was not set
-
partnerName:
string
Property description was not set
-
resources:
object resources
Property description was not set
-
serialNumber:
string
Property description was not set
- sharedSecret: string
-
softwareRevision:
string
Property description was not set
-
softwareVersion:
string
Property description was not set
Nested Schema : childrenDevices
Type:
objectProperty description was not set
Show Source
-
links(optional):
array links
The set of API navigation links.
Nested Schema : ConnectivityStatus_receive
Type:
Show Source
object-
lastHeardEpochTime:
integer
Property description was not set
-
onlineSinceEpochTime:
integer
Property description was not set
-
onlineSinceTime:
integer
Property description was not set
-
status:
string
One of [NEVER_HEARD_FROM, OFFLINE, ONLINE].
Nested Schema : directlyConnectedOwner
Type:
Show Source
object-
links(optional):
array links
The set of API navigation links.
Nested Schema : location
Type:
Show Source
object-
links(optional):
array links
The set of API navigation links.
Nested Schema : Logs_receive
Type:
Show Source
object-
logCount:
integer
Property description was not set
-
logs:
object LogBuffer_receive
-
logType:
string
One of [ACTIVATION].
Nested Schema : metadata
Type:
objectProperty description was not set
Show Source
-
links(optional):
array links
The set of API navigation links.
Nested Schema : resources
Type:
objectProperty description was not set
Show Source
-
links(optional):
array links
The set of API navigation links.
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
Nested Schema : DeviceModelModel_receive
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
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
Nested Schema : LogBuffer_receive
Type:
Show Source
object-
empty:
boolean
Property description was not set
-
full:
boolean
Property description was not set
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
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
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.
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.