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
POST /api/v2/tasks/929cc399-ed36-4d50-9260-b47e509e109a/comments
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "comments",
"attributes": {
"body": "MyText",
"updated_in_db_at": "2022-01-12 17:19:00 UTC"
},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "1d0bf43f-d563-426b-9eaa-47f92385aae4"
}
}
}
}
}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
Content-Type: application/vnd.api+json; charset=utf-8
201 CreatedBody
{
"data": {
"id": "02495369-43f5-4837-b13e-82e9c8cf3bd8",
"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": {
"id": "1d0bf43f-d563-426b-9eaa-47f92385aae4",
"type": "people"
}
}
}
}
}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
GET /api/v2/tasks/ffe245ee-be90-4fac-8d53-11e3c227a526/comments/0f215371-856c-4051-8454-9c2ea917bfb9
Content-Type: application/vnd.api+jsonBody
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OKBody
{
"data": {
"id": "0f215371-856c-4051-8454-9c2ea917bfb9",
"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
}
}
}
}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
PUT /api/v2/tasks/adf134fc-f368-48d3-8882-0a528e783309/comments/8b0ea860-a993-486e-b88e-3d7e6405dc8e
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "comments",
"attributes": {
"body": "MyText",
"updated_in_db_at": "2022-01-12 17:19:00 UTC"
},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "45765141-e61d-4ec4-a8ba-677619c18507"
}
}
}
}
}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
Content-Type: application/vnd.api+json; charset=utf-8
200 OKBody
{
"data": {
"id": "8b0ea860-a993-486e-b88e-3d7e6405dc8e",
"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": {
"id": "45765141-e61d-4ec4-a8ba-677619c18507",
"type": "people"
}
}
}
}
}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
DELETE /api/v2/tasks/d8c1f4dc-a5e9-4209-91e1-daeaf64e83d3/comments/3d85500d-b251-4025-af58-ac6746179dc0
Content-Type: application/vnd.api+jsonBody
Response
Headers
204 No ContentBody
Last updated