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

List incidents

get

/fleetMonitoring/clientapi/v2/incidents/

This operation returns the list of incidents that exist for the current application instance.

Request

Query Parameters
Header Parameters
  • To allow targeting requests to different organizations. The header value should contain the organization identifier(orgId). This header is optional, if not provided orgId will be ORA_DEFAULT_ORG
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : FleetIncident_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 : tags
Type: array
Tags assigned to the incident
Show Source
Nested Schema : Comment_receive
Type: object
Show Source

401 Response

Unauthorized. The request requires user authentication.

406 Response

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/fleetMonitoring/clientapi/v2/incidents/

Example of Response Body

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


{
    "offset":0,
    "count":2,
    "limit":10,
    "hasMore":false,
    "links":[
        {
            "rel":"self",
            "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
        },
        {
            "rel":"canonical",
            "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
        }
    ],
    "items":[
        {
            "summary":"Short high-level description",
            "comments":[
                {
                    "createdBy":"Author of Incident comment",
                    "createdTime":1469184297746,
                    "links":[
                        {
                            "rel":"self",
                            "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
                        },
                        {
                            "rel":"canonical",
                            "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
                        }
                    ],
                    "text":"Text of Incident comment",
                    "state":"State of Incident comment",
                    "type":"USER_DEFINED"
                }
            ],
            "lastModifiedTime":1469184297746,
            "lastModifiedBy":"last modified by",
            "lastModifiedTimeAsString":"2016-07-22T10:44:57.746Z",
            "description":"Detailed description",
            "rule":"Id of rule the incident was created for. May be null if the incident was created manually",
            "priority":"LOW",
            "type":"Type of Incident",
            "tags":[
                "tags_1",
                "tags_2",
                "tags_3"
            ],
            "createdBy":"User ID or a special ID reserved for Oracle IoT Cloud Service",
            "geoLocation":"incident geoLocation",
            "incidentTimeAsString":"2016-07-22T10:44:57.746Z",
            "createdTimeAsString":"2016-07-22T10:44:57.746Z",
            "createdTime":1469184297746,
            "links":[
                {
                    "rel":"self",
                    "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
                },
                {
                    "rel":"canonical",
                    "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
                }
            ],
            "incidentTime":1469184297746,
            "id":"7c19313c4eac-565e",
            "state":"NEW"
        },
        {
            "summary":"Short high-level description",
            "comments":[
                {
                    "createdBy":"Author of Incident comment",
                    "createdTime":1469184297746,
                    "links":[
                        {
                            "rel":"self",
                            "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
                        },
                        {
                            "rel":"canonical",
                            "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
                        }
                    ],
                    "text":"Text of Incident comment",
                    "state":"State of Incident comment",
                    "type":"USER_DEFINED"
                }
            ],
            "lastModifiedTime":1469184297746,
            "lastModifiedBy":"last modified by",
            "lastModifiedTimeAsString":"2016-07-22T10:44:57.746Z",
            "description":"Detailed description",
            "rule":"Id of rule the incident was created for. May be null if the incident was created manually",
            "priority":"LOW",
            "type":"Type of Incident",
            "tags":[
                "tags_1",
                "tags_2",
                "tags_3"
            ],
            "createdBy":"User ID or a special ID reserved for Oracle IoT Cloud Service",
            "geoLocation":"incident geoLocation",
            "incidentTimeAsString":"2016-07-22T10:44:57.746Z",
            "createdTimeAsString":"2016-07-22T10:44:57.746Z",
            "createdTime":1469184297746,
            "links":[
                {
                    "rel":"self",
                    "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
                },
                {
                    "rel":"canonical",
                    "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
                }
            ],
            "incidentTime":1469184297746,
            "id":"352154de59ba-33dd",
            "state":"NEW"
        }
    ]
}



Complete cURL Example

The following example shows the complete cURL command that can be used to perform the described operation:

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/fleetMonitoring/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