Comments
Comments Documentation
Comment [LIST]
Comment [LIST]
Request
Endpoint
GET /api/v2/tasks/79bf10de-2a7d-4239-8e25-388f2c0e3fce/comments
Content-Type: application/vnd.api+jsonBody
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OKBody
{
"data": [
{
"id": "62b351ad-92cd-4874-a57e-c064957e8df0",
"type": "comments",
"attributes": {
"body": "MyText",
"created_at": "2022-01-12T17:19:00Z",
"updated_at": "2022-01-12T17:19:00Z",
"updated_in_db_at": "2022-01-12T17:19:00Z"
},
"relationships": {
"person": {
"data": null
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}Fields
data
Type
[Comment]
Description An array of Comments
Comment [POST]
Comment [POST]
Request
Endpoint
Body
Parameters
Attributes
body
Type
string
Description content of comment
Required No
created_at
Type
date
Description The timestamp of when this resource was created
Required No
updated_at
Type
date
Description The timestamp of when this resource was last updated
Required No
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Required No
Relationships
person.data
Type
Person
Description person comment belongs to
Required No
Response
Headers
Body
Fields
Attributes
body
Type
string
Description content of comment
created_at
Type
date
Description The timestamp of when this resource was created
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Relationships
person.data
Type
Person
Description person comment belongs to
Comment [GET]
Comment [GET]
Request
Endpoint
Body
Response
Headers
Body
Fields
Attributes
body
Type
string
Description content of comment
created_at
Type
date
Description The timestamp of when this resource was created
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Relationships
person.data
Type
Person
Description person comment belongs to
Comment [PUT]
Comment [PUT]
Request
Endpoint
Body
Parameters
Attributes
body
Type
string
Description content of comment
Required No
created_at
Type
date
Description The timestamp of when this resource was created
Required No
overwrite
Type
boolean
Description
Only used for updating a record where you want to ignore the server's ' 'updated_in_db_at value and force overwrite the values for the record. ' 'Must be true to work.
Required No
updated_at
Type
date
Description The timestamp of when this resource was last updated
Required No
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Required No
Relationships
person.data
Type
Person
Description person comment belongs to
Required No
Response
Headers
Body
Fields
Attributes
body
Type
string
Description content of comment
created_at
Type
date
Description The timestamp of when this resource was created
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Relationships
person.data
Type
Person
Description person comment belongs to
Comment [DELETE]
Comment [DELETE]
Request
Endpoint
Body
Response
Headers
Body
Last updated