Comments
Comments Documentation
Comment [LIST]
Comment [LIST]
Request
Endpoint
GET /api/v2/tasks/01135578-4701-46a8-953e-4b43688f1fc3/comments
Content-Type: application/vnd.api+jsonBody
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OKBody
{
"data": [
{
"id": "7785e001-7fa1-4782-b5a3-5aa1b7563119",
"type": "comments",
"attributes": {
"body": "MyText",
"created_at": "2021-11-23T14:37:31Z",
"updated_at": "2021-11-23T14:37:31Z",
"updated_in_db_at": "2021-11-23T14:37:31Z"
},
"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/3cb1224f-f416-49d4-9ad1-8845bc1154bc/comments
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "comments",
"attributes": {
"body": "MyText",
"updated_in_db_at": "2021-11-23 14:37:31 UTC"
},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "2636fac0-277f-4fc8-8ea4-ffde53d7f500"
}
}
}
}
}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": "82aed6df-d98c-4903-8d90-f5dd91f215f8",
"type": "comments",
"attributes": {
"body": "MyText",
"created_at": "2021-11-23T14:37:31Z",
"updated_at": "2021-11-23T14:37:31Z",
"updated_in_db_at": "2021-11-23T14:37:31Z"
},
"relationships": {
"person": {
"data": {
"id": "2636fac0-277f-4fc8-8ea4-ffde53d7f500",
"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/3a9a5f04-2db7-49c0-ab0e-7a4715166ec6/comments/ac592b81-8d0c-4145-9338-3d272cb3a42f
Content-Type: application/vnd.api+jsonBody
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OKBody
{
"data": {
"id": "ac592b81-8d0c-4145-9338-3d272cb3a42f",
"type": "comments",
"attributes": {
"body": "MyText",
"created_at": "2021-11-23T14:37:30Z",
"updated_at": "2021-11-23T14:37:30Z",
"updated_in_db_at": "2021-11-23T14:37:30Z"
},
"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/0bd5a1e1-e9a6-472f-b616-72c4d727b800/comments/a1d53dca-3b42-46bb-b70b-061d73a03081
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "comments",
"attributes": {
"body": "MyText",
"updated_in_db_at": "2021-11-23 14:37:30 UTC"
},
"relationships": {
"person": {
"data": {
"type": "people",
"id": "9745ba6b-1a23-4e75-afa8-7fddf4a54740"
}
}
}
}
}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": "a1d53dca-3b42-46bb-b70b-061d73a03081",
"type": "comments",
"attributes": {
"body": "MyText",
"created_at": "2021-11-23T14:37:30Z",
"updated_at": "2021-11-23T14:37:30Z",
"updated_in_db_at": "2021-11-23T14:37:30Z"
},
"relationships": {
"person": {
"data": {
"id": "9745ba6b-1a23-4e75-afa8-7fddf4a54740",
"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/29828a72-a4b5-4f56-84da-a7f91d27872a/comments/4b447341-1e6a-41bb-b3dc-b0810fdab323
Content-Type: application/vnd.api+jsonBody
Response
Headers
204 No ContentBody
Last updated