Retrieve machine incidents by ID
get
/productionMonitoring/clientapi/v2/machines/{machine-id}/incidents
Retrieve machine incidents by machine 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
-
machine-id: string
The unique identifier of the machine to get metrics from Oracle IoT Cloud Service
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
The ordering criteria for the returned factory list.
-
q(optional): string
Query to filter machines 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 : ProductionIncident_receive
Type:
Show Source
object
-
comments:
array comments
Comments
-
contextInformation:
object ContextInformationModel_receive
-
createdBy:
string
User ID or a special ID reserved for IoT CS
-
createdTime:
integer
Creation time
-
createdTimeAsString:
integer
Creation time as String
-
description:
string
Detailed description
-
geoLocation:
string
incident geoLocation
-
id:
string
Unique ID for each incident
-
incidentTime:
integer
incident time
-
incidentTimeAsString:
integer
incident time as string
-
lastModifiedBy:
string
last modified by
-
lastModifiedTime:
integer
lastModified time
-
lastModifiedTimeAsString:
integer
lastModified time as string
-
metadata:
object metadata
Additional Properties Allowed: additionalPropertiesincident metadata map
-
priority:
string
Incident priorityOne of [LOW, MEDIUM, HIGH].
-
rule:
string
Id of rule the incident was created for. May be null if the incident was created manually
-
state:
string
Incident stateOne of [NEW, OPEN, WORK_IN_PROGRESS, RESOLVED, WITHDRAWN].
-
summary:
string
Short high-level description
-
tags:
array tags
Tags assigned to the incident
-
type:
string
Type of Incident
Nested Schema : ContextInformationModel_receive
Type:
Show Source
object
-
affectedObjects:
array affectedObjects
Property description was not set
-
occurrences:
array occurrences
Property description was not set
Nested Schema : metadata
Type:
object
Additional Properties Allowed
Show Source
-
string
A map of the following type: Map<String, String>
incident metadata map
Show Source
Nested Schema : IncidentCommentModel_receive
Type:
Show Source
object
-
createdBy:
string
Author of Incident comment
-
createdTime:
integer
Date of Incident comment
-
state:
string
State of Incident comment
-
text:
string
Text of Incident comment
-
type:
string
Type of Incident comment, One of [USER_DEFINED, LIFECYCLE_STATE_TRANSITION].
Nested Schema : ProductionMonitoringWarningAffectedObject_receive
Type:
Show Source
object
-
factoryId:
string
Property description was not set
-
id:
string
Property description was not set
-
machineTypeId:
string
Property description was not set
-
machineTypeName:
string
Property description was not set
-
name:
string
Property description was not set
-
workOrderId:
string
Property description was not set
Nested Schema : RuleOccurrence_receive
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
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/productionMonitoring/clientapi/v2/machines/{machine-id}/incidents
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"comments":[
{
"createdBy":"Author of Incident comment",
"createdTime":1469184297746,
"state":"State of Incident comment",
"text":"Text of Incident comment",
"type":"Type of Incident comment, One of [USER_DEFINED, LIFECYCLE_STATE_TRANSITION]."
}
],
"contextInformation":{
"affectedObjects":[
{
"factoryId":"5b82679572d2-845",
"id":"5afc3ab9e0b-70e9",
"machineTypeId":"47aaaf950f3-307c",
"machineTypeName":"Property description was not set",
"name":"Property description was not set",
"workOrderId":"5feb5a71379d-7d93"
}
],
"occurrences":[
{
"id":"7967a83aa9-29d6",
"incidentId":"2ad4315e58f0-ee6",
"satisfiedPredicates":[
{
"information":{
"information_key1":"information_value1",
"information_key2":"information_value2",
"information_key3":"information_value3"
},
"type":"Property description was not set"
}
],
"time":12345
}
]
},
"createdBy":"User ID or a special ID reserved for IoT CS",
"createdTime":1469184297746,
"createdTimeAsString":1469184297746,
"description":"Detailed description",
"geoLocation":"incident geoLocation",
"id":"72d661d333b9-5400",
"incidentTime":1469184297746,
"incidentTimeAsString":1469184297746,
"lastModifiedBy":"last modified by",
"lastModifiedTime":1469184297746,
"lastModifiedTimeAsString":1469184297746,
"metadata":{
"metadata_key1":"metadata_value1",
"metadata_key2":"metadata_value2",
"metadata_key3":"metadata_value3"
},
"priority":"Incident priorityOne of [LOW, MEDIUM, HIGH].",
"rule":"Id of rule the incident was created for. May be null if the incident was created manually",
"state":"Incident stateOne of [NEW, OPEN, WORK_IN_PROGRESS, RESOLVED, WITHDRAWN].",
"summary":"Short high-level description",
"tags":[
"tags_1",
"tags_2",
"tags_3"
],
"type":"Type of Incident"
}
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/machines/2f6f77e2750f-204a/incidents
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.