1. REST API for Oracle IoT Asset Monitoring Cloud Service
  2. Tasks
  3. Asset Rules

List rules

get

/assetMonitoring/clientapi/v2/rules

This operation returns the list of all vertical application rules. Actions are returned as part of the rule.

Request

Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : RuleDocModel_receive_list
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : actions
Type: array
Property description was not set
Show Source
Nested Schema : config
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : predicates
Type: array
Property description was not set
Show Source
Nested Schema : sources
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : RuleActionDocModel_receive
Type: object
Show Source
Nested Schema : config
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : tags
Type: array
Property description was not set
Show Source
Nested Schema : PredicateModel_receive
Type: object
Show Source
Nested Schema : config
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source

401 Response

Unauthorized. The request requires user authentication.

406 Response

Request Not Acceptable. The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.
Back to Top

Examples

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/assetMonitoring/clientapi/v2/rules

Example of Response Body

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


{
    "count":2,
    "hasMore":false,
    "items":[
        {
            "actions":[
                {
                    "config":{
                        "config_key1":"config_value1",
                        "config_key2":"config_value2",
                        "config_key3":"config_value3"
                    },
                    "id":"52206b5239e-71ac",
                    "tags":[
                        "tags_1",
                        "tags_2",
                        "tags_3"
                    ],
                    "type":"One of [TRIGGERALERT, TRIGGERINCIDENT, TRIGGERWARNING, TRIGGERSOURCEPROCEDURE]."
                }
            ],
            "applicationId":"609d476ab2-5a5d",
            "config":{
                "config_key1":"config_value1",
                "config_key2":"config_value2",
                "config_key3":"config_value3"
            },
            "createdTime":1469184297746,
            "createdTimeAsString":"2016-07-22T10:44:57.746Z",
            "description":"Property description was not set",
            "id":"6b8c63cc4848-1da1",
            "lastModifiedTime":1469184297746,
            "lastModifiedTimeAsString":"2016-07-22T10:44:57.746Z",
            "name":"Property description was not set",
            "organizationId":"719932660-69d7",
            "predicateCombination":"One of [ANY_OF, ALL_OF].",
            "predicates":[
                {
                    "config":{
                        "config_key1":"config_value1",
                        "config_key2":"config_value2",
                        "config_key3":"config_value3"
                    },
                    "type":"One of [THRESHOLD, GEO, ALERT, ANOMALY, PREDICTION, TREND]."
                }
            ],
            "sources":{
                "sources_key1":"sources_value1",
                "sources_key2":"sources_value2",
                "sources_key3":"sources_value3"
            },
            "state":"One of [ENABLED, DISABLED, INVALID].",
            "system":false
        },
        {
            "actions":[
                {
                    "config":{
                        "config_key1":"config_value1",
                        "config_key2":"config_value2",
                        "config_key3":"config_value3"
                    },
                    "id":"4183149578d-2dc7",
                    "tags":[
                        "tags_1",
                        "tags_2",
                        "tags_3"
                    ],
                    "type":"One of [TRIGGERALERT, TRIGGERINCIDENT, TRIGGERWARNING, TRIGGERSOURCEPROCEDURE]."
                }
            ],
            "applicationId":"10d47695619b-6012",
            "config":{
                "config_key1":"config_value1",
                "config_key2":"config_value2",
                "config_key3":"config_value3"
            },
            "createdTime":1469184297746,
            "createdTimeAsString":"2016-07-22T10:44:57.746Z",
            "description":"Property description was not set",
            "id":"3586c9683e-1570",
            "lastModifiedTime":1469184297746,
            "lastModifiedTimeAsString":"2016-07-22T10:44:57.746Z",
            "name":"Property description was not set",
            "organizationId":"4b4d5cdd6c88-b60",
            "predicateCombination":"One of [ANY_OF, ALL_OF].",
            "predicates":[
                {
                    "config":{
                        "config_key1":"config_value1",
                        "config_key2":"config_value2",
                        "config_key3":"config_value3"
                    },
                    "type":"One of [THRESHOLD, GEO, ALERT, ANOMALY, PREDICTION, TREND]."
                }
            ],
            "sources":{
                "sources_key1":"sources_value1",
                "sources_key2":"sources_value2",
                "sources_key3":"sources_value3"
            },
            "state":"One of [ENABLED, DISABLED, INVALID].",
            "system":false
        }
    ],
    "limit":10,
    "links":[
        {
            "href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
            "rel":"self"
        },
        {
            "href":"https://iotserver/assetMonitoring/clientapi/version/resource/path",
            "rel":"canonical"
        }
    ],
    "offset":0
}



Complete cURL Example

The following example shows a complete cURL command that you can use to perform the described operation:

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/assetMonitoring/clientapi/v2/rules



Note that in the request, https://iotserver will be replaced by the name and port of your assigned IoT Cloud Service instance. The format of the Cloud Service instance is https://myinstance-myidentitydomain.iot.us.oraclecloud.com and the default port is 443.
Back to Top