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

Update incident by ID

post

/fleetMonitoring/clientapi/v2/incidents/{incident-id}

This operation updates information about an incident specified by its ID, with the provided incident definition that is either partial or complete.

Request

Supported Media Types
Path Parameters
Header Parameters
  • To perform a partial update of the incident, POST request should be orchestrated with method override set to PATCH.
  • 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
Body ()
Root Schema : FleetIncident_update
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : FleetIncident_receive
Type: object
Show Source
Nested Schema : comments
Type: array
Comments
Show Source
Nested Schema : metadata
Type: object
Additional Properties Allowed
Show Source
  • 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 : Comment_receive
Type: object
Show Source

400 Response

Bad Request. The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

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.

405 Response

Method Not Allowed. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

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.

415 Response

Unsupported Media Type. The request entity has a media type which the server or resource does not support.
Back to Top

Examples

curl -X POST 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   -H 'Content-Type: application/json' 
   --header "X-HTTP-Method-Override: PATCH" 
   https://iotserver/fleetMonitoring/clientapi/v2/incidents/{incident-id}

Example of Request Body

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

 {
    "summary":"Short high-level description",
    "description":"Detailed description",
    "state":"NEW",
    "priority":"LOW"
}

Example of Response Body

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


{
    "summary":"Short high-level description",
    "metadata":{
        "metadata_key1":"metadata_value1",
        "metadata_key2":"metadata_value2",
        "metadata_key3":"metadata_value3"
    },
    "lastModifiedTime":1469184297746,
    "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"
        }
    ],
    "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",
    "type":"Type of Incident, ",
    "priority":"LOW",
    "tags":[
        "tags_1",
        "tags_2",
        "tags_3"
    ],
    "geoLocation":"incident geoLocation",
    "createdBy":"User ID or a special ID reserved for IoT CS",
    "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"
        }
    ],
    "state":"NEW",
    "incidentTime":1469184297746
}



Complete cURL Example

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

curl -X POST 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   -H 'Content-Type: application/json' 
   --header "X-HTTP-Method-Override: PATCH"  
   -d '{"action":"Id of action the incident was created for. May be null if the incident was created manually"}'
   https://iotserver/fleetMonitoring/clientapi/v2/incidents/1399191955dc-28e5



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