List rules
get
/fleetMonitoring/clientapi/v2/rules/
This operation returns the list of all vertical application rules. Actions are returned as part of the rule.
Request
Query Parameters
-
expand(optional): string
List of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
-
fields(optional): string
The comma-separated list of fields to be shown in response. By default all response object fields will be present.
-
limit(optional): integer
Maximum number of entries to return to end-user.
-
offset(optional): integer
The number that the first record of results is starting from.
-
orderBy(optional): string
Ordering criteria for the returned Rules list.
-
q(optional): string
Query to filter Rules on the server. (For more information on mongoDB query parameters refer to Using mongoDB Query Syntax)
-
since(optional): integer
Starting point of interested time interval in milliseconds, default 0.
-
totalResults(optional): boolean
Total number of results which suites particular end-user request.
-
until(optional): integer
Finishing point of interested time interval in milliseconds, default 0.
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=collection
200 Response
Successfully processed.
Root Schema : Rule_receive_list
Type:
Show Source
object
-
count:
integer(int32)
-
hasMore:
boolean
-
items:
array items
-
limit:
integer(int32)
-
links:
array links
The set of API navigation links.
-
offset:
integer(int32)
Nested Schema : items
Type:
Show Source
object
-
actions:
array actions
Rule actions
-
applicationId:
string
Id of application the rule belongs to
-
config:
object config
Additional Properties Allowed: additionalPropertiesRule Config
-
createdTime:
integer
Creation time
-
createdTimeAsString:
string
Creation time as String
-
description:
string
Detailed description
-
id:
string
Unique ID for each rule
-
lastModifiedTime:
integer
lastModified time
-
lastModifiedTimeAsString:
string
lastModified time as string
-
links:
array links
The set of API navigation links.
-
name:
string
Rule name
-
predicateCombination:
string
Rule predicateCombination, PredicateCombination one of [ANY_OF, ALL_OF]
-
predicates:
array predicates
Rule Predicates
-
sources:
object sources
Additional Properties Allowed: additionalPropertiesRule Sources
-
state:
string
Rule Status, State one of [ENABLED, DISABLED, INVALID]
-
system:
boolean
System flag
Nested Schema : config
Type:
object
Additional Properties Allowed
Show Source
-
string
Map of the following type: Map<String, String>
Rule Config
Show Source
Nested Schema : sources
Type:
object
Additional Properties Allowed
Show Source
-
string
Map of the following type: Map<String, String>
Rule Sources
Show Source
Nested Schema : Action_receive
Type:
Show Source
object
-
config:
object config
Additional Properties Allowed: additionalPropertiesConfig of Action
-
links:
array links
The set of API navigation links.
-
tags:
array tags
Tags of Action
-
type:
string
Type of Action, Type one of [TRIGGERALERT, TRIGGERINCIDENT, TRIGGERWARNING]
Nested Schema : config
Type:
object
Additional Properties Allowed
Show Source
-
string
Map of the following type: Map<String, String>
Config of Action
Show Source
Nested Schema : items
Type:
Show Source
object
-
href:
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel:
string
Relation typeExample:
canonical
Nested Schema : items
Type:
Show Source
object
-
href:
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel:
string
Relation typeExample:
canonical
Nested Schema : Predicate_receive
Type:
Show Source
object
-
config:
object config
Additional Properties Allowed: additionalPropertiesConfig of Predicate
-
links:
array links
The set of API navigation links.
-
type:
string
Type of Predicate, Type one of [THRESHOLD, GEO, ALERT]
Nested Schema : config
Type:
object
Additional Properties Allowed
Show Source
-
string
Map of the following type: Map<String, String>
Config of Predicate
Show Source
Nested Schema : items
Type:
Show Source
object
-
href:
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel:
string
Relation typeExample:
canonical
Nested Schema : items
Type:
Show Source
object
-
href:
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel:
string
Relation typeExample:
canonical
401 Response
Unauthorized. The request requires user authentication.
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.
Examples
curl -X GET
-u <username>:<password>
-H 'Accept: application/json'
https://iotserver/fleetMonitoring/clientapi/v2/rules/
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"offset":0,
"count":2,
"limit":10,
"hasMore":false,
"links":[
{
"rel":"self",
"href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
},
{
"rel":"canonical",
"href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
}
],
"items":[
{
"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":"36cb6522276a-228e",
"state":"ENABLED",
"applicationId":"1207df04f5e-5d82",
"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"
]
}
]
},
{
"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":"6f8d39284234-2239",
"state":"ENABLED",
"applicationId":"1d2ecc0f29-5bd2",
"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/
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
.