Retrieve incident occurrences by incident ID
get
/productionMonitoring/clientapi/v2/incidents/{incident-id}/occurrences
This operation returns the list of occurrences of an incident specified by its incident ID. 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
Path Parameters
-
incident-id: string
The unique identifier of the incident
Query Parameters
-
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.
-
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 : FmRuleOccurrence_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
-
id:
string
Property description was not set
-
incidentId:
string
Property description was not set
-
satisfiedPredicates:
array satisfiedPredicates
Property description was not set
-
time:
integer
Property description was not set
Nested Schema : SatisfiedPredicate_receive
Type:
Show Source
object
-
information:
object information
Additional Properties Allowed: additionalPropertiesProperty description was not set
-
type:
string
Property description was not set
Nested Schema : information
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 : 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/incidents/{incident-id}/occurrences
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"count":2,
"hasMore":false,
"items":[
{
"id":"72fe74d01fa1-4f9e",
"incidentId":"580f6bf24106-31ff",
"satisfiedPredicates":[
{
"information":{
"information_key1":"information_value1",
"information_key2":"information_value2",
"information_key3":"information_value3"
},
"type":"Property description was not set"
}
],
"time":12345
},
{
"id":"1df554483bba-27e6",
"incidentId":"343e33774919-391d",
"satisfiedPredicates":[
{
"information":{
"information_key1":"information_value1",
"information_key2":"information_value2",
"information_key3":"information_value3"
},
"type":"Property description was not set"
}
],
"time":12345
}
],
"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/incidents/7613358168a8-2a66/occurrences
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.