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

Update incident by ID

post

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

This operation modifies the details of an incident specified by its Incident ID. You can update the definition of that incident partially or completely.

Request

Supported Media Types
Path Parameters
Header Parameters
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
Property description was not set
Show Source
Nested Schema : metadata
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : tags
Type: array
Property description was not set
Show Source
Nested Schema : IncidentCommentModel_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

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.

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/assetMonitoring/clientapi/v2/incidents/{incident-id}

Example of Request Body

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


{
    "organizationId":"7f4b203d4dbb-73ae"
}

Example of Response Body

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


{
    "comments":[
        {
            "createdBy":"Property description was not set",
            "createdTime":1469184297746,
            "state":"Property description was not set",
            "text":"Property description was not set",
            "type":"One of [USER_DEFINED, LIFECYCLE_STATE_TRANSITION]."
        }
    ],
    "createdBy":"Property description was not set",
    "createdTime":1469184297746,
    "createdTimeAsString":"2016-07-22T10:44:57.746Z",
    "description":"Property description was not set",
    "geoLocation":"Property description was not set",
    "incidentTime":1469184297746,
    "incidentTimeAsString":"2016-07-22T10:44:57.746Z",
    "lastModifiedBy":"Property description was not set",
    "lastModifiedTime":1469184297746,
    "lastModifiedTimeAsString":"2016-07-22T10:44:57.746Z",
    "metadata":{
        "metadata_key1":"metadata_value1",
        "metadata_key2":"metadata_value2",
        "metadata_key3":"metadata_value3"
    },
    "organizationId":"2b42795a5f24-1914",
    "priority":"One of [LOW, MEDIUM, HIGH].",
    "rule":"Property description was not set",
    "state":"One of [NEW, OPEN, WORK_IN_PROGRESS, RESOLVED, WITHDRAWN].",
    "summary":"Property description was not set",
    "tags":[
        "tags_1",
        "tags_2",
        "tags_3"
    ],
    "type":"Property description was not set"
}



Complete cURL Example

The following example shows a complete cURL command that you can use 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 '{"organizationId":"7f4b203d4dbb-73ae"}'
   https://iotserver/assetMonitoring/clientapi/v2/incidents/618e4b7b5836-4d88



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