Retrieve the List of Message Format Associations
get
/iot/api/v2/apps/{app-id}/explorations
Retrieve the list of message format associations with its explorations, for an IoT Application. The API is deprecated and may be removed in a future release.
Request
Path Parameters
-
app-id: string
A unique identifier for the IoT Application
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=collection
200 Response
Successfully processed.
Root Schema : ApplicationExplorationModel_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
-
description:
string
Text description of the message format
-
explorationID:
string
ID of the exploration, that needs to be associated with the newly created message format
-
name:
string
Name of the message format
-
severity:
string
Optional field, the severity of the generated alerts, if not present the severity will be set to default SIGNIFICANT
-
type:
string
Type of the messages that should be generated from the exploration output, possible values for now are "data" and "alert"
-
urn:
string
Format URN
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
Examples
The following example shows how to get a list of message formats associated with explorations for a certain 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 -i -X GET -H 'Accept:application/json' -H 'Authorization: Basic aW90OndlbGNvbWUx' "http://iotserver:7101/iot/api/v2/apps/0-AM/explorations"
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 list of message format associations with explorations in JSON format.{
"items":[
{
"urn":"urn:oracle:iot:exploration:ThermometerExploration2",
"explorationID":"145",
"name":"My Thermometer Exploration2 Format",
"description":"My Thermometer Exploration Format2 Description",
"type":"data",
"severity":"SIGNIFICANT"
},
{
"urn":"urn:oracle:iot:exploration:ThermometerExploration1",
"explorationID":"131",
"name":"My Thermometer Exploration Format",
"description":"My Thermometer Exploration Format Description",
"type":"data",
"severity":"SIGNIFICANT"
}
],
"links":[
{
"href":"http://iotserver:7101/iot/api/v2/apps/0-AM/explorations",
"rel":"self"
}
],
"count":2
}