Jump to

• Request
• Response
• Examples

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

Back to Top

Response

Supported Media Types

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

200 Response

Successfully processed.

Body ()

Root Schema : ApplicationExplorationModel_receive_list

Type: object

Show Source

• count: integer(int32)
• hasMore: boolean
• items: array items
• limit: integer(int32)
• links: array links
  The set of API navigation links.
• offset: integer(int32)

{
    "properties":{
        "count":{
            "format":"int32",
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "items":{
            "items":{
                "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"
            },
            "type":"array"
        },
        "limit":{
            "format":"int32",
            "type":"integer"
        },
        "links":{
            "description":"The set of API navigation links.",
            "items":{
                "properties":{
                    "href":{
                        "description":"The target resource URI",
                        "example":"https://iotserver/iot/api/vX/some/API/path",
                        "type":"string"
                    },
                    "rel":{
                        "description":"Relation type",
                        "example":"canonical",
                        "type":"string"
                    }
                },
                "type":"object"
            },
            "type":"array"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        }
    },
    "required":[
        "items",
        "links",
        "limit",
        "offset",
        "count",
        "hasMore"
    ],
    "type":"object"
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "items":{
        "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"
    },
    "type":"array"
}

Nested Schema : links

Type: array

The set of API navigation links.

Show Source

• Array of: object items

{
    "description":"The set of API navigation links.",
    "items":{
        "properties":{
            "href":{
                "description":"The target resource URI",
                "example":"https://iotserver/iot/api/vX/some/API/path",
                "type":"string"
            },
            "rel":{
                "description":"Relation type",
                "example":"canonical",
                "type":"string"
            }
        },
        "type":"object"
    },
    "type":"array"
}

Nested Schema : items

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"
}

Nested Schema : items

Type: object

Show Source

• href(optional): string
  The target resource URI

  Example: https://iotserver/iot/api/vX/some/API/path
• rel(optional): string
  Relation type

  Example: canonical

{
    "properties":{
        "href":{
            "description":"The target resource URI",
            "example":"https://iotserver/iot/api/vX/some/API/path",
            "type":"string"
        },
        "rel":{
            "description":"Relation type",
            "example":"canonical",
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top

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
}

Back to Top