Set Incident Annotation

Sets the annotation of an incident with the given id.

Method

PUT /incident/{id}/annotation

Parameters

Path Parameters

Name Description
id The id of the incident to set the annotation at.

Request Body

A JSON object with the following properties:

Name Description
annotation An arbitrary text annotation set by a user.

Result

This method returns no content.

Response Codes

Code Media type Description
204 Request successful.
400 application/json Returned if no incident can be found for the given id. See the Introduction for the error response format.

Example

Request

PUT /incident/a02a5890-ad41-11e9-8609-d5bbb7c7e9e3/annotation

Request Body:

{
  "annotation": "Cannot identify root cause"
}

Response

Status 204. No content.

On this Page: