REST API for Oracle Internet of Things Cloud Service

Retrieve Applications Count

get

/iot/api/v2/apps/count

Retrieve IoT Applications count. This request supports querying application. That allows retrieving count of the applications by various filters

Request

Query Parameters

q(optional): string

Query to filter subset of applications which count will be returned (For more information on mongoDB query parameters refer to Using mongoDB Query Syntax.)

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"
}

401 Response

Unauthorized. The request requires user authentication.

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 applications count of the 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/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"
      }
   ]
}