logo

Comment

This document describes the API for reading, creating, updating, and deleting Comments.

List Comments

Returns a list of Comments.

Search parameters

Filter Description
commentable_type The type of the commentable object
commentable_id The ID of the commentable object
company_id The ID of the company
content The content of the comment
id The ID of the comment
Securityheader_authorization
Request
query Parameters
include
string

Set to a comma separated list of related resources to include in the response

page
integer

Used for pagination of response data (default: page 1). Specifies the offset of the next block of data to receive.

per_page
integer

Used for pagination of response data (default: 100 items per response). Specifies the number of results for a given page.

q
string

Search and filter the Comment data using Lucene syntax.

relationships
boolean

Set to true to return the associated relationships data within the response. (default: false)

Responses
400

Bad Request

401

Unauthorized

403

Forbidden

default
get/comments
Request samples 
Response samples 
application/json
[
  • {
    }
]
Create a Comment
Creates a new Comment


Securityheader_authorization 
Request 
query Parameters
commentable_id
string
The ID of the commentable resource


 
commentable_type
string
The type of the commentable resource (e.g., "test", "risk", "vendor")


 
content
string
The content of the comment


 
conversation_id
string
Optional conversation ID to associate with the comment


 
Responses 
400
Bad Request


401
Unauthorized


403
Forbidden


default
post/comments
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "includes": { }
}
Get a Comment
Returns a single Comment by ID


Securityheader_authorization 
Request 
path Parameters
id
required
string
Scope response to id


 
Responses 
400
Bad Request


401
Unauthorized


403
Forbidden


404
Resource not found


default
get/comments/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "includes": { }
}
Update a Comment
Updates a Comment by ID


Securityheader_authorization 
Request 
path Parameters
id
required
string
Scope response to id


 
query Parameters
content
string
The updated content of the comment


 
Responses 
400
Bad Request


401
Unauthorized


403
Forbidden


404
Resource not found


default
put/comments/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "includes": { }
}
Delete a Comment
Deletes a Comment by ID


Securityheader_authorization 
Request 
path Parameters
id
required
string
Scope response to id


 
Responses 
400
Bad Request


401
Unauthorized


403
Forbidden


404
Resource not found


default
delete/comments/{id}
Request samples 
Response samples 
application/json
{ }
➔ Next to Control