Jump to

• Request
• Response
• Examples

Add comments to an incident

post

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

This operation adds a comment to an incident that is specified by its ID.

Request

Supported Media Types

• application/json

Path Parameters

• incident-id: string
  ID of the incident to be commented.

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.

Body ()

Root Schema : IncidentCommentImpl_create

Type: object

Show Source

• text: string
  Property description was not set

{
    "properties":{
        "text":{
            "description":"Property description was not set",
            "type":"string"
        }
    },
    "required":[
        "text"
    ],
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.resource+json;type=singular

201 Response

Successfully processed.

Body ()

Root Schema : IncidentCommentImpl_receive

Type: object

Show Source

• createdBy: string
  Property description was not set
• createdTime: integer
  Property description was not set
• state: string
  Property description was not set
• text: string
  Property description was not set
• type: string
  One of [USER_DEFINED, LIFECYCLE_STATE_TRANSITION].

{
    "properties":{
        "createdBy":{
            "description":"Property description was not set",
            "type":"string"
        },
        "createdTime":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "state":{
            "description":"Property description was not set",
            "type":"string"
        },
        "text":{
            "description":"Property description was not set",
            "type":"string"
        },
        "type":{
            "description":"One of [USER_DEFINED, LIFECYCLE_STATE_TRANSITION].",
            "type":"string"
        }
    },
    "required":[
        "createdBy",
        "createdTime",
        "state",
        "type",
        "text"
    ],
    "type":"object"
}

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.

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' 
   https://iotserver/assetMonitoring/clientapi/v2/incidents/{incident-id}/comments 

Example of Request Body

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

{
    "text":"Property description was not set"
} 

Example of Response Body

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

{
    "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]."
} 

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'  
   -d '{"text":"Property description was not set"}'
   https://iotserver/assetMonitoring/clientapi/v2/incidents/407f3e3b62e0-2e01/comments 

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