1. REST API for Oracle Internet of Things Cloud Service
  2. Tasks
  3. IoT Application Exploration

Retrieve Exploration Sources of an Application

get

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

Retrieve the list of Exploration Sources for an IoT Application. The API is deprecated and may be removed in a future release.

Request

Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : AnalyticsImpl_receive_list
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : annotations
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Annotations that will be applied to the messages passed to the Analytics engine
Show Source
Nested Schema : ConnectivityStatus_receive
Type: object
Show Source
Nested Schema : directlyConnectedOwner
Type: object
Directly connected owner to Endpoint
Show Source
Nested Schema : MessageAnnotatorModel_receive
Type: object
Show Source
Nested Schema : MessageFormatModel_receive
Type: object
Show Source
Nested Schema : metadata
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Endpoint metadata
Show Source
Nested Schema : resources
Type: array
List of endpoints resources
Show Source
Nested Schema : apps
Type: array
Show Source
Nested Schema : source
Type: array
Show Source
Nested Schema : annotations
Type: array
Property description was not set
Show Source
Nested Schema : MessageAnnotation_receive
Type: object
Show Source
Nested Schema : appFields
Type: array
Property description was not set
Show Source
Nested Schema : destinationFields
Type: array
Property description was not set
Show Source
Nested Schema : senderFields
Type: array
Property description was not set
Show Source
Nested Schema : sourceFields
Type: array
Property description was not set
Show Source
Nested Schema : MessageFormatValue_receive
Type: object
Show Source
Nested Schema : fields
Type: array
Property description was not set
Show Source
Nested Schema : MessageFormatField_receive
Type: object
Show Source
Nested Schema : EndpointResourceModel_receive
Type: object
Show Source
Nested Schema : methods
Type: array
This array may contain the following items: GET, POST, PUT, DELETE.
Show Source

401 Response

Unauthorized. The request requires user authentication.

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.

405 Response

Method Not Allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

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.
Back to Top

Examples

The following example shows how to retrieve all the explorationSources instances for an application 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 -H 'Content-Type: application/json' -H 'Authorization: Basic aW90OndlbGNvbWUx' "http://iotserver:7101/iot/api/v2/apps/0-AM/explorationSources"

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 containing the endpoint Ids for the retrieved explorationSources instances in JSON format 

{
   "items":[
      {
         "annotations":null,
         "applicationid":"0-AM",
         "callbackUrl":null,
         "description":"Readings from my thermometer",
         "format":"urn:com:oracle:iot:device:thermometer:attributes",
         "id":"0-BQ",
         "name":"My Thermometer Source",
         "state":"ENABLED",
         "streamid":"90",
         "type":"OEP",
         "activationTime":null,
         "activationTimeAsString":null,
         "created":1468284574765,
         "createdAsString":"2016-07-12T00:49:34.765Z",
         "directlyConnectedOwner":null,
         "lastHeardTimeAsString":null,
         "messageAnnotatorId":null,
         "messageFormat":{
            "urn":"urn:com:oracle:iot:device:thermometer:attributes",
            "name":"Thermometer",
            "description":"",
            "type":"DATA",
            "deviceModel":"urn:com:oracle:iot:device:thermometer",
            "value":{
               "fields":[
                  {
                     "name":"temperature",
                     "optional":false,
                     "type":"NUMBER"
                  }
               ]
            }
         },
         "metadata":{

         },
         "resources":[

         ],
         "sharedSecret":null
      },
      {
         "annotations":null,
         "applicationid":"0-AM",
         "callbackUrl":null,
         "description":"Readings from my other thermometer",
         "format":"urn:com:oracle:iot:device:thermometer:attributes",
         "id":"0-BU",
         "name":"My Other Thermometer Source",
         "state":"ENABLED",
         "streamid":"99",
         "type":"OEP",
         "activationTime":null,
         "activationTimeAsString":null,
         "created":1468284799312,
         "createdAsString":"2016-07-12T00:53:19.312Z",
         "directlyConnectedOwner":null,
         "lastHeardTimeAsString":null,
         "messageAnnotatorId":null,
         "messageFormat":{
            "urn":"urn:com:oracle:iot:device:thermometer:attributes",
            "name":"Thermometer",
            "description":"",
            "type":"DATA",
            "deviceModel":"urn:com:oracle:iot:device:thermometer",
            "value":{
               "fields":[
                  {
                     "name":"temperature",
                     "optional":false,
                     "type":"NUMBER"
                  }
               ]
            }
         },
         "metadata":{

         },
         "resources":[

         ],
         "sharedSecret":null
      }
   ],
   "links":[
      {
         "href":"http://iotserver:7101/iot/api/v2/apps/0-AM/explorationSources?offset=0&limit=10",
         "rel":"self"
      },
      {
         "href":"http://iotserver:7101/iot/api/v2/apps/0-AM/explorationSources",
         "rel":"canonical"
      },
      {
         "href":"http://iotserver:7101/iot/api/v2/apps/0-AM/explorationSources?offset=0&limit=10",
         "rel":"first"
      },
      {
         "href":"http://iotserver:7101/iot/api/v2/apps/0-AM/explorationSources?offset=0&limit=10",
         "rel":"last"
      }
   ],
   "offset":0,
   "limit":10,
   "count":2,
   "hasMore":false
}
Back to Top