Skip to content
adversarial

Create a new comment for an incident

POST
/v1/incidents/{id}/comments
curl --request POST \
  --url https://api.adversarial.com/api/v1/incidents/INC-00001/comments \
  --header 'Content-Type: application/json' \
  --data '{ "attachment_file_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "value": "example" }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

The ID of the incident to create a comment for — INC-00001 (case-insensitive) or a bare number

Example
INC-00001

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
attachment_file_ids

Ids of files to attach to the comment. Each must already be attached to the risk or incident the comment is posted on; if any is not, the request is refused with 400 and no comment is created. Repeated ids are attached once. At most 20.

Array<string>
<= 20 items
value
required
string
Examplegenerated
{
  "attachment_file_ids": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "value": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Comment created

Media typeapplication/json
object
attachments

Files attached to this comment. A file is uploaded to the parent risk or incident first and referenced here when the comment is created; the set is fixed at creation and is not changed by editing the comment.

Array<object>

A file attached to a risk, an incident, or a comment on either.

Embedded in the attachments list of the record it is attached to, and returned when a file is uploaded to a risk or incident.

object
byte_size

File size in bytes.

integer | null format: int64
content_type
required

MIME content type.

string
created_by

The user who uploaded the file, if known. On a comment’s attachments this can differ from the comment’s author: a comment may reference a file someone else uploaded to the same record.

string | null format: uuid
created_date
required

When the file was uploaded.

string format: date-time
id
required

The attachment’s id; download it with GET /v1/files/{id}.

string format: uuid
name
required

Original file name as uploaded.

string
status
required

The file’s upload status. Attachments are only listed once their upload has finished, so this is always ready.

string
Allowed values: pending ready failed
created_date
required
string format: date-time
id
required
string format: uuid
updated_date
string | null format: date-time
user
required

A User as returned by the API.

Profile images are not embedded — clients fetch them from GET /api/v1/{icon} when icon is Some.

object
email
required
string
first_name
required
string
icon

Relative path to the user’s avatar endpoint, e.g. "users/{id}/avatar?v={hash}". None when the user has no avatar.

string | null
id
required
string format: uuid
last_name
required
string
value
required
string
Example
{
  "attachments": [
    {
      "status": "pending"
    }
  ]
}

404

Section titled “404”

Incident not found