1. REST API for Oracle IoT Production Monitoring Cloud Service
  2. Tasks
  3. Incidents

Retrieve all incidents

get

/productionMonitoring/clientapi/v2/incidents

This operation returns information about all the incidents 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
Header Parameters
  • 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.
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : ProductionIncident_receive_list
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : comments
Type: array
Comments
Show Source
Nested Schema : ContextInformationModel_receive
Type: object
Show Source
Nested Schema : metadata
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
incident metadata map
Show Source
Nested Schema : tags
Type: array
Tags assigned to the incident
Show Source
Nested Schema : IncidentCommentModel_receive
Type: object
Show Source
Nested Schema : affectedObjects
Type: array
Property description was not set
Show Source
Nested Schema : occurrences
Type: array
Property description was not set
Show Source
Nested Schema : ProductionMonitoringWarningAffectedObject_receive
Type: object
Show Source
Nested Schema : RuleOccurrence_receive
Type: object
Show Source
Nested Schema : satisfiedPredicates
Type: array
Property description was not set
Show Source
Nested Schema : SatisfiedPredicate_receive
Type: object
Show Source
Nested Schema : information
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source

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.
Back to Top

Examples

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/productionMonitoring/clientapi/v2/incidents

Example of Response Body

The following example shows the content of the response body in JSON format:


{
    "count":2,
    "hasMore":false,
    "items":[
        {
            "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":"d157cb44d01-7d67",
                        "id":"7806cdc1c83-3374",
                        "machineTypeId":"6b4a5b234f2e-4f30",
                        "machineTypeName":"Property description was not set",
                        "name":"Property description was not set",
                        "workOrderId":"162958962c0d-428"
                    }
                ],
                "occurrences":[
                    {
                        "id":"68a24a22c67-3538",
                        "incidentId":"2b5460984587-314e",
                        "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":"56c2524263aa-105d",
            "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"
        },
        {
            "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":"43324f4525a8-3e0b",
                        "id":"11359ff4f5b-79d8",
                        "machineTypeId":"66ed1b423013-33c4",
                        "machineTypeName":"Property description was not set",
                        "name":"Property description was not set",
                        "workOrderId":"3df360309f7-34a7"
                    }
                ],
                "occurrences":[
                    {
                        "id":"4534de0736e-75bd",
                        "incidentId":"fb823234798-4433",
                        "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":"28a6ff36bf5-3364",
            "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"
        }
    ],
    "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



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.
Back to Top