Jump to

• Request
• Response
• Examples

Create a Message Format and Associate with an Exploration

post

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

Create a new 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

Body ()

Root Schema : ApplicationExplorationModel_create

Type: object

Show Source

• 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

{
    "properties":{
        "description":{
            "description":"Text description of the message format",
            "type":"string"
        },
        "explorationID":{
            "description":"ID of the exploration, that needs to be associated with the newly created message format",
            "type":"string"
        },
        "name":{
            "description":"Name of the message format",
            "type":"string"
        },
        "severity":{
            "description":"Optional field, the severity of the generated alerts, if not present the severity will be set to default SIGNIFICANT",
            "type":"string"
        },
        "type":{
            "description":"Type of the messages that should be generated from the exploration output, possible values for now are "data" and "alert"",
            "type":"string"
        },
        "urn":{
            "description":"Format URN",
            "type":"string"
        }
    },
    "required":[
        "urn",
        "explorationID",
        "description",
        "name",
        "type"
    ],
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.resource+json;type=singular

201 Response

Successfully processed.

Body ()

Root Schema : ApplicationExplorationModel_receive

Type: object

Show Source

• 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

{
    "properties":{
        "description":{
            "description":"Text description of the message format",
            "type":"string"
        },
        "explorationID":{
            "description":"ID of the exploration, that needs to be associated with the newly created message format",
            "type":"string"
        },
        "name":{
            "description":"Name of the message format",
            "type":"string"
        },
        "severity":{
            "description":"Optional field, the severity of the generated alerts, if not present the severity will be set to default SIGNIFICANT",
            "type":"string"
        },
        "type":{
            "description":"Type of the messages that should be generated from the exploration output, possible values for now are "data" and "alert"",
            "type":"string"
        },
        "urn":{
            "description":"Format URN",
            "type":"string"
        }
    },
    "required":[
        "urn",
        "explorationID",
        "description",
        "severity",
        "name",
        "type"
    ],
    "type":"object"
}

Back to Top

Examples

The following example shows how to create a new message format and associate it with an exploration by submitting a POST 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 POST -H 'Content-Type: application/json' -H 'Authorization:Basic aW90OndlbGNvbWUx' -d '{ "urn" : "urn:oracle:iot:exploration:ThermometerExploration1", "explorationID" : "131", "name" : "My Thermometer Exploration Format", "description" : "My Thermometer Exploration Format Description"}' "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 201 Created

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
 "status": "Ok"
}

Back to Top