REST API for Oracle Internet of Things Cloud Service

Retrieve Number of Devices of an Application that Implements a Specific Device Model

get

/iot/api/v2/apps/{app-id}/deviceModels/{urn}/devices/count

Retrieve a document with the total number of devices that implement the given device model for the app.

Request

Path Parameters

app-id: string

Unique identifier of the application
urn: string

URN of the implemented device model

Response

Supported Media Types

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

200 Response

Successfully processed.

Root Schema : RecordsCount_receive

Type: object

Show Source

count: integer

Property description was not set

{
    "properties":{
        "count":{
            "description":"Property description was not set",
            "type":"integer"
        }
    },
    "required":[
        "count"
    ],
    "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.

Examples

The following example shows how to view the number of devices having a device model of type urn:example:unique:identifier:of:the:resource:43b4 of an application with app-id 63b36d2e204b-5c4 of an IoT Cloud Service instance by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

Note:

In the request and response, iotserver will be replaced by name and port of your assigned Oracle IoT Cloud Service instance. The format of the Cloud Service instance is myinstance-myidentitydomain.iot.us.oraclecloud.com and the default port is 443.

curl -X GET -k -H 'Accept: application/json' -u 'username@example.com:password' http://iotserver/iot/api/v2/apps/63b36d2e204b-5c4/deviceModels/urn:example:unique:identifier:of:the:resource:43b4/devices/count

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Content-Type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
   "count":2,
   "links":[
      {
         "rel":"self",
         "href":"http://iotserver/iot/api/version/resource/path"
      },
      {
         "rel":"canonical",
         "href":"http://iotserver/iot/api/version/resource/path"
      }
   ]
}