Retrieve all rules
get
/productionMonitoring/clientapi/v2/rules
This operation returns information about all the rules that are filtered by a query. This method supports the request header with name 'X-ORACLE-IOT-ORG', which allows targeting requests to different organizations. The value of this request header should contain the organization identifier.
Request
Query Parameters
-
expand(optional): string
The 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
The maximum number of entries to return to the end user.
-
offset(optional): integer
The number that the first record of results is starting from.
-
orderBy(optional): string
Ordering criteria for the returned rule 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
The starting point of the desired time interval, in milliseconds. The default is 0.
-
totalResults(optional): boolean
The total number of results suiting the request.
-
until(optional): integer
The finishing point of the desired time interval, in milliseconds. The default is 0.
Header Parameters
-
X-ORACLE-IOT-ORG: string
This method supports the request header with name 'X-ORACLE-IOT-ORG', which allows targeting requests to different organizations. The value of this request header should contain the organization identifier.
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=collection
200 Response
Successfully processed.
Root Schema : RuleDocModel_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
The set of actions for the rule.
-
applicationId:
string
The ID of application the rule belongs to.
-
config:
object config
Additional Properties Allowed: additionalPropertiesThe rule configuration.
-
createdTime:
integer
The time at which the rule was created.
-
createdTimeAsString:
string
The time at which the rule was created, represented as a string.
-
description:
string
The detailed description of the rule.
-
id:
string
The unique ID for the rule.
-
lastModifiedTime:
integer
The time at which the rule was last modified.
-
lastModifiedTimeAsString:
string
The time at which the rule was last modified, represented as a string.
-
name:
string
The name of the rule.
-
organizationId:
string
The ID of organization the rule belongs to.
-
predicateCombination:
string
The manner in which to combine rule predicates. One of [ANY_OF, ALL_OF].
-
predicates:
array predicates
The predicates for the rule.
-
sources:
object sources
Additional Properties Allowed: additionalPropertiesThe source of the rule.
-
state:
string
The state of the rule. One of [ENABLED, DISABLED, INVALID].
-
system:
boolean
The system flag.
Nested Schema : config
Type:
object
Additional Properties Allowed
Show Source
-
string
A map of the following type: Map<String, String>
The rule configuration.
Show Source
Nested Schema : sources
Type:
object
Additional Properties Allowed
Show Source
-
string
A map of the following type: Map<String, String>
The source of the rule.
Show Source
Nested Schema : RuleActionDocModel_receive
Type:
Show Source
object
-
config:
object config
Additional Properties Allowed: additionalPropertiesConfig of Action
-
id:
string
Property description was not set
-
tags:
array tags
Tags of Action
-
type:
string
Type of Action, One of [TRIGGERALERT, TRIGGERINCIDENT, TRIGGERWARNING].
Nested Schema : config
Type:
object
Additional Properties Allowed
Show Source
-
string
A map of the following type: Map<String, String>
Config of Action
Show Source
Nested Schema : PredicateModel_receive
Type:
Show Source
object
-
config:
object config
Additional Properties Allowed: additionalPropertiesConfig of Predicate
-
type:
string
Type of Predicate, One of [THRESHOLD, GEO, ALERT, ANOMALY, PREDICTION, TREND].
Nested Schema : config
Type:
object
Additional Properties Allowed
Show Source
-
string
A map of the following type: Map<String, String>
Config of Predicate
Show Source
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel(optional):
string
Relation typeExample:
canonical
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.
Examples
curl -X GET
-u <username>:<password>
-H 'Accept: application/json'
https://iotserver/productionMonitoring/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":"2f6e67565132-414d",
"tags":[
"tags_1",
"tags_2",
"tags_3"
],
"type":"Type of Action, One of [TRIGGERALERT, TRIGGERINCIDENT, TRIGGERWARNING]."
}
],
"applicationId":"54473ec37067-6de0",
"config":{
"config_key1":"config_value1",
"config_key2":"config_value2",
"config_key3":"config_value3"
},
"createdTime":1469184297746,
"createdTimeAsString":"2016-07-22T10:44:57.746Z",
"description":"The detailed description of the rule.",
"id":"4eab4d351a4d-1ec1",
"lastModifiedTime":1469184297746,
"lastModifiedTimeAsString":"2016-07-22T10:44:57.746Z",
"name":"The name of the rule.",
"organizationId":"383b6d3f3305-4871",
"predicateCombination":"The manner in which to combine rule predicates. One of [ANY_OF, ALL_OF].",
"predicates":[
{
"config":{
"config_key1":"config_value1",
"config_key2":"config_value2",
"config_key3":"config_value3"
},
"type":"Type of Predicate, One of [THRESHOLD, GEO, ALERT, ANOMALY, PREDICTION, TREND]."
}
],
"sources":{
"sources_key1":"sources_value1",
"sources_key2":"sources_value2",
"sources_key3":"sources_value3"
},
"state":"The state of the rule. One of [ENABLED, DISABLED, INVALID].",
"system":false
},
{
"actions":[
{
"config":{
"config_key1":"config_value1",
"config_key2":"config_value2",
"config_key3":"config_value3"
},
"id":"45effb85594-473d",
"tags":[
"tags_1",
"tags_2",
"tags_3"
],
"type":"Type of Action, One of [TRIGGERALERT, TRIGGERINCIDENT, TRIGGERWARNING]."
}
],
"applicationId":"2e9f41bf3473-7ef6",
"config":{
"config_key1":"config_value1",
"config_key2":"config_value2",
"config_key3":"config_value3"
},
"createdTime":1469184297746,
"createdTimeAsString":"2016-07-22T10:44:57.746Z",
"description":"The detailed description of the rule.",
"id":"39091076690-65e6",
"lastModifiedTime":1469184297746,
"lastModifiedTimeAsString":"2016-07-22T10:44:57.746Z",
"name":"The name of the rule.",
"organizationId":"7f1f50af530c-3710",
"predicateCombination":"The manner in which to combine rule predicates. One of [ANY_OF, ALL_OF].",
"predicates":[
{
"config":{
"config_key1":"config_value1",
"config_key2":"config_value2",
"config_key3":"config_value3"
},
"type":"Type of Predicate, One of [THRESHOLD, GEO, ALERT, ANOMALY, PREDICTION, TREND]."
}
],
"sources":{
"sources_key1":"sources_value1",
"sources_key2":"sources_value2",
"sources_key3":"sources_value3"
},
"state":"The state of the rule. One of [ENABLED, DISABLED, INVALID].",
"system":false
}
],
"limit":10,
"links":[
{
"href":"https://iotserver/productionMonitoring/clientapi/version/resource/path",
"rel":"self"
},
{
"href":"https://iotserver/productionMonitoring/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/productionMonitoring/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.