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

Update rule by ID

post

/fleetMonitoring/clientapi/v2/rules/{rule-id}

This operation updates information about a rule specified by its ID, with the provided rule definition that is either partial or complete.

Request

Supported Media Types
Path Parameters
Header Parameters
  • To perform a partial update of the rule, POST request should be orchestrated with method override set to PATCH.
  • To allow targeting requests to different organizations. The header value should contain the organization identifier(orgId). This header is optional, if not provided orgId will be ORA_DEFAULT_ORG
Body ()
Root Schema : Rule_update
Type: object
Show Source
Nested Schema : actions
Type: array
Rule actions
Show Source
Nested Schema : config
Type: object
Additional Properties Allowed
Show Source
  • Map of the following type: Map<String, String>
Rule Config
Show Source
Nested Schema : predicates
Type: array
Rule Predicates
Show Source
Nested Schema : sources
Type: object
Additional Properties Allowed
Show Source
  • Map of the following type: Map<String, String>
Rule Sources
Show Source
Nested Schema : Action_update
Type: object
Show Source
Nested Schema : config
Type: object
Additional Properties Allowed
Show Source
  • Map of the following type: Map<String, String>
Config of Action
Show Source
Nested Schema : tags
Type: array
Tags of Action
Show Source
Nested Schema : Predicate_update
Type: object
Show Source
Nested Schema : config
Type: object
Additional Properties Allowed
Show Source
  • Map of the following type: Map<String, String>
Config of Predicate
Show Source
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : Rule_receive
Type: object
Show Source
Nested Schema : actions
Type: array
Rule actions
Show Source
Nested Schema : config
Type: object
Additional Properties Allowed
Show Source
  • Map of the following type: Map<String, String>
Rule Config
Show Source
Nested Schema : predicates
Type: array
Rule Predicates
Show Source
Nested Schema : sources
Type: object
Additional Properties Allowed
Show Source
  • Map of the following type: Map<String, String>
Rule Sources
Show Source
Nested Schema : Action_receive
Type: object
Show Source
Nested Schema : config
Type: object
Additional Properties Allowed
Show Source
  • Map of the following type: Map<String, String>
Config of Action
Show Source
Nested Schema : tags
Type: array
Tags of Action
Show Source
Nested Schema : Predicate_receive
Type: object
Show Source
Nested Schema : config
Type: object
Additional Properties Allowed
Show Source
  • Map of the following type: Map<String, String>
Config of Predicate
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.

404 Response

Not Found. The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.

405 Response

Method Not Allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

406 Response

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' 
   --header "X-HTTP-Method-Override: PATCH" 
   https://iotserver/fleetMonitoring/clientapi/v2/rules/{rule-id}

Example of Request Body

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


{
    "predicates":[
        {
            "type":"THRESHOLD",
            "config":{
                "config_key1":"config_value1",
                "config_key2":"config_value2",
                "config_key3":"config_value3"
            }
        }
    ],
    "sources":{
        "sources_key1":"sources_value1"
    },
    "predicateCombination":"ANY_OF",
    "name":"Rule name",
    "description":"Detailed description",
    "state":"ENABLED",
    "config":{
        "config_key1":"config_value1",
        "config_key2":"config_value2",
        "config_key3":"config_value3"
    },
    "actions":[
        {
            "type":"TRIGGERALERT",
            "config":{
                "config_key1":"config_value1",
                "config_key2":"config_value2",
                "config_key3":"config_value3"
            },
            "tags":[
                "tags_1",
                "tags_2",
                "tags_3"
            ]
        }
    ]
}

Example of Response Body

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


{
    "lastModifiedTime":1469184297746,
    "sources":{
        "sources_key1":"sources_value1",

    },
    "predicateCombination":"ANY_OF",
    "lastModifiedTimeAsString":"2016-07-22T10:44:57.746Z",
    "description":"Detailed description",
    "predicates":[
        {
            "links":[
                {
                    "rel":"self",
                    "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
                },
                {
                    "rel":"canonical",
                    "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
                }
            ],
            "type":"THRESHOLD",
            "config":{
                "config_key1":"config_value1",
                "config_key2":"config_value2",
                "config_key3":"config_value3"
            }
        }
    ],
    "system":false,
    "createdTimeAsString":"2016-07-22T10:44:57.746Z",
    "name":"Rule name",
    "createdTime":1469184297746,
    "links":[
        {
            "rel":"self",
            "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
        },
        {
            "rel":"canonical",
            "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
        }
    ],
    "id":"7934230b5023-450c",
    "state":"ENABLED",
    "applicationId":"bf35f41742e-6615",
    "config":{
        "config_key1":"config_value1",
        "config_key2":"config_value2",
        "config_key3":"config_value3"
    },
    "actions":[
        {
            "links":[
                {
                    "rel":"self",
                    "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
                },
                {
                    "rel":"canonical",
                    "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
                }
            ],
            "type":"TRIGGERALERT",
            "config":{
                "config_key1":"config_value1",
                "config_key2":"config_value2",
                "config_key3":"config_value3"
            },
            "tags":[
                "tags_1",
                "tags_2",
                "tags_3"
            ]
        }
    ]
}



Complete cURL Example

The following example shows the complete cURL command that can be used to perform the described operation:

curl -X POST 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   -H 'Content-Type: application/json' 
   --header "X-HTTP-Method-Override: PATCH"  
   -d '{"predicates":[{"type":"THRESHOLD","config":{"config_key1":"config_value1","config_key2":"config_value2","config_key3":"config_value3"}}],"sources":{"sources_key1":"sources_value1"},"predicateCombination":"ANY_OF","name":"Rule name","description":"Detailed description","state":"ENABLED","config":{"config_key1":"config_value1","config_key2":"config_value2","config_key3":"config_value3"},"actions":[{"type":"TRIGGERALERT","config":{"config_key1":"config_value1","config_key2":"config_value2","config_key3":"config_value3"},"tags":["tags_1","tags_2","tags_3"]}]}'
   https://iotserver/fleetMonitoring/clientapi/v2/rules/12ea57e314dd-60d3



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