Retrieve the Message Format Association with an Exploration
get
/iot/api/v2/apps/{app-id}/explorations/{explorationID}
Retrieve detailed data about the message format and its associations with an exploration.
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
-
explorationID: string
Unique identifier of the exploration
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=singular
200 Response
Successfully processed.
Root Schema : ApplicationExplorationModel_receive
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
Examples
The following example shows how to retrieve detailed data about message format associated with an exploration 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/131"
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 message format association with the exploration in JSON format.
{
"urn":"urn:oracle:iot:exploration:ThermometerExploration1",
"explorationID":"131",
"name":"My Thermometer Exploration Format",
"description":"My Thermometer Exploration Format Description",
"type":"data",
"severity":"SIGNIFICANT"
}