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

Create rule

post

/assetMonitoring/clientapi/v2/rules

This operation creates a new instance of a rule that is applicable to the entire application.

Request

Supported Media Types
Body ()
Root Schema : RuleDocModel_create
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_create
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_create
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
Back to Top

Response

Supported Media Types

202 Response

Successfully processed.
Body ()
Root Schema : RuleDocModel_receive
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

400 Response

Bad Request. The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

401 Response

Unauthorized. The request requires user authentication.

403 Response

Forbidden. The server understood the request, but is refusing to fulfill it. Authorization will not help and the request SHOULD NOT be repeated.

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.

415 Response

Unsupported Media Type. The request entity has a media type which the server or resource does not support.
Back to Top

Examples

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

Example of Request Body

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


{
    "actions":[
        {
            "config":{
                "config_key1":"config_value1",
                "config_key2":"config_value2",
                "config_key3":"config_value3"
            },
            "tags":[
                "tags_1",
                "tags_2",
                "tags_3"
            ],
            "type":"One of [TRIGGERALERT, TRIGGERINCIDENT, TRIGGERWARNING, TRIGGERSOURCEPROCEDURE]."
        }
    ],
    "config":{
        "config_key1":"config_value1",
        "config_key2":"config_value2",
        "config_key3":"config_value3"
    },
    "description":"Property description was not set",
    "name":"Property description was not set",
    "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]."
}

Example of Response Body

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


{
    "actions":[
        {
            "config":{
                "config_key1":"config_value1",
                "config_key2":"config_value2",
                "config_key3":"config_value3"
            },
            "id":"35ac3c7076d6-4564",
            "tags":[
                "tags_1",
                "tags_2",
                "tags_3"
            ],
            "type":"One of [TRIGGERALERT, TRIGGERINCIDENT, TRIGGERWARNING, TRIGGERSOURCEPROCEDURE]."
        }
    ],
    "applicationId":"229552ed1da4-43c0",
    "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":"1222a50510f-abf",
    "lastModifiedTime":1469184297746,
    "lastModifiedTimeAsString":"2016-07-22T10:44:57.746Z",
    "name":"Property description was not set",
    "organizationId":"63ac564731f-47a",
    "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
}



Complete cURL Example

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

curl -X POST 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   -H 'Content-Type: application/json'  
   -d '{"actions":[{"config":{"config_key1":"config_value1","config_key2":"config_value2","config_key3":"config_value3"},"tags":["tags_1","tags_2","tags_3"],"type":"One of [TRIGGERALERT, TRIGGERINCIDENT, TRIGGERWARNING, TRIGGERSOURCEPROCEDURE]."}],"config":{"config_key1":"config_value1","config_key2":"config_value2","config_key3":"config_value3"},"description":"Property description was not set","name":"Property description was not set","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]."}'
   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