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

Retrieve rule details

get

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

This operation returns information about a vertical application rule that is specified by its ID.

Request

Path Parameters
Query Parameters
  • List of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
  • The comma-separated list of fields to be shown in response. By default all response object fields will be present.
Header Parameters
  • 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
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

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.

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.
Back to Top

Examples

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/fleetMonitoring/clientapi/v2/rules/{rule-id}

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":"153b25073321-5c6f",
    "state":"ENABLED",
    "applicationId":"1fc7650e4634-32b7",
    "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 GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/fleetMonitoring/clientapi/v2/rules/73736c45683-3c01



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