Update the Message Format and Associate with an Exploration
put
/iot/api/v2/apps/{app-id}/explorations/{explorationID}
Update the message format and associate it with an exploration, for an IoT Application.
The API is deprecated and may be removed in a future release.
Request
Supported Media Types
- application/json
Path Parameters
-
app-id: string
A unique identifier for the IoT Application
-
explorationID: string
Unique identifier of the exploration
Query Parameters
-
force(optional): boolean
Updating a message format is a potentially hazardous operation. Integrations or analytic explorations may depend on existing message format. By passing this query parameter, the caller acknowledges their willingness to proceed.
Root Schema : ApplicationExplorationModel_create
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(optional):
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
Response
204 Response
Successfully processed.
Examples
The following example shows how to update the message format associated with an exploration by submitting a PUT request on the REST resource using cURL. For more information about cURL, see
Use cURL.
Note:
In the request,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 PUT -H 'Content-Type: application/json' -H 'Authorization:Basic aW90OndlbGNvbWUx' -d '{ "urn" : "urn:oracle:iot:exploration:UpdatedThermometerExploration", "name" : "My Updated Thermometer Exploration Format", "explorationID": "131", "description" : "My Updated Thermometer Exploration Format Description"}' "http://iotserver:7101/iot/api/v2/apps/0-AM/explorations/131?force"
Example of Response Header
The following shows an example of the response header as a result of the request. There is no content in the body of the response.
HTTP/1.1 204 No Content