Retrieve rule by ID
get
/assetMonitoring/clientapi/v2/rules/{rule-id}
This operation returns information about a vertical application rule that is specified by its ID.
Request
Path Parameters
-
rule-id: string
The ID of rule to be retrieved.
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.
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=singular
200 Response
Successfully processed.
Root Schema : RuleDocModel_receive
Type:
Show Source
object
-
actions:
array actions
Property description was not set
-
applicationId:
string
Property description was not set
-
config:
object config
Additional Properties Allowed: additionalPropertiesProperty description was not set
-
createdTime:
integer
Property description was not set
-
createdTimeAsString:
string
Property description was not set
-
description:
string
Property description was not set
-
id:
string
Property description was not set
-
lastModifiedTime:
integer
Property description was not set
-
lastModifiedTimeAsString:
string
Property description was not set
-
name:
string
Property description was not set
-
organizationId:
string
Property description was not set
-
predicateCombination:
string
One of [ANY_OF, ALL_OF].
-
predicates:
array predicates
Property description was not set
-
sources:
object sources
Additional Properties Allowed: additionalPropertiesProperty description was not set
-
state:
string
One of [ENABLED, DISABLED, INVALID].
-
system:
boolean
Property description was not set
Nested Schema : config
Type:
object
Additional Properties Allowed
Show Source
-
string
A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : sources
Type:
object
Additional Properties Allowed
Show Source
-
string
A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : RuleActionDocModel_receive
Type:
Show Source
object
-
config:
object config
Additional Properties Allowed: additionalPropertiesProperty description was not set
-
id:
string
Property description was not set
-
tags:
array tags
Property description was not set
-
type:
string
One of [TRIGGERALERT, TRIGGERINCIDENT, TRIGGERWARNING, TRIGGERSOURCEPROCEDURE].
Nested Schema : config
Type:
object
Additional Properties Allowed
Show Source
-
string
A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : PredicateModel_receive
Type:
Show Source
object
-
config:
object config
Additional Properties Allowed: additionalPropertiesProperty description was not set
-
type:
string
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>
Property description was not set
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
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/assetMonitoring/clientapi/v2/rules/{rule-id}
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":"2a34658546e-2283",
"tags":[
"tags_1",
"tags_2",
"tags_3"
],
"type":"One of [TRIGGERALERT, TRIGGERINCIDENT, TRIGGERWARNING, TRIGGERSOURCEPROCEDURE]."
}
],
"applicationId":"633d750e77b2-5fe4",
"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":"5db0662070d0-5ff5",
"lastModifiedTime":1469184297746,
"lastModifiedTimeAsString":"2016-07-22T10:44:57.746Z",
"name":"Property description was not set",
"organizationId":"48283bfe11bb-19b1",
"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 GET
-u <username>:<password>
-H 'Accept: application/json'
https://iotserver/assetMonitoring/clientapi/v2/rules/6e4d407fd66-502c
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.