Task comments

Discussion on a task.

The object#

FieldTypeDescription
idread-onlyintegerNolaPro id.
teamprojecttaskidintegerTeamprojecttaskid. Id only - teamprojecttask is read-only or has no code key.
parentcommentidintegerParentcommentid. Id only.
commenttextComment. Stored as text, no practical length limit.
cancelbooleanCancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-onlystringWhen the record was created.
lastchangedateread-onlystringLast modification. Drives modifiedsince.
externalidstring(100)Your own key. Scoped to your company.

Endpoints#

POST/teamprojectcomments/batch 207

Create many.

Requires scope projects:write.

Parameters
NameInTypeNotes
Body array
FieldTypeDescription
parentcommentidintegerParentcommentid. Id only.
commenttextComment. Stored as text, no practical length limit.
cancelbooleanCancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-onlystringWhen the record was created.
externalidstring(100)Your own key. Scoped to your company.
teamprojecttaskidintegerTeamprojecttaskid. Id only - teamprojecttask is read-only or has no code key.
curl -X POST \
  'https://acme.nolapro.com/!/api/v2/teamprojectcomments/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "parentcommentid": 104,
        "comment": "Example comment",
        "teamprojecttaskid": 104
    }
]'
GET/teamprojectcomments 200403

List task comments.

Requires scope projects:read.

Parameters
NameInTypeNotes
cancelquerystringDefaults to false. Pass true or any.
modifiedsincequerystringRFC 3339 UTC timestamp. Returns only records changed since then, including cancelled ones - so cancel defaults to any rather than false when this is used. The response carries _meta.synced_through; store it and send it back next time.
externalidquerystringExact match on your own key.
teamprojecttaskidquerystringFilter to one task.
includequerystringComma-separated extras to embed. Only custom_fields is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.
When it fails
StatusCodeMeaning
403insufficient_scopeToken lacks read scope.
curl \
  'https://acme.nolapro.com/!/api/v2/teamprojectcomments' \
  -H 'Authorization: Bearer $NP_TOKEN'
POST/teamprojectcomments 201400

Create.

Requires scope projects:write.

Parameters
NameInTypeNotes
Body
FieldTypeDescription
parentcommentidintegerParentcommentid. Id only.
commenttextComment. Stored as text, no practical length limit.
cancelbooleanCancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-onlystringWhen the record was created.
externalidstring(100)Your own key. Scoped to your company.
teamprojecttaskidintegerTeamprojecttaskid. Id only - teamprojecttask is read-only or has no code key.
When it fails
StatusCodeMeaning
400invalid_requestA required field was missing.
curl -X POST \
  'https://acme.nolapro.com/!/api/v2/teamprojectcomments' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "parentcommentid": 104,
    "comment": "Example comment",
    "teamprojecttaskid": 104
}'
Response 201
{
    "teamprojecttaskid": 104,
    "parentcommentid": 104,
    "comment": "Example comment"
}
GET/teamprojectcomments/{id} 200404

Retrieve one record.

Requires scope projects:read.

Parameters
NameInTypeNotes
idrequiredpathintegerThe record id.
includequerystringComma-separated extras to embed. Only custom_fields is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.
When it fails
StatusCodeMeaning
404not_foundNo record with that id.
curl \
  'https://acme.nolapro.com/!/api/v2/teamprojectcomments/104' \
  -H 'Authorization: Bearer $NP_TOKEN'
Response 200
{
    "teamprojecttaskid": 104,
    "parentcommentid": 104,
    "comment": "Example comment"
}
PATCH/teamprojectcomments/{id} 200404

Update.

Requires scope projects:write.

Parameters
NameInTypeNotes
idrequiredpathintegerThe record id.
Body
FieldTypeDescription
idread-onlyintegerNolaPro id.
teamprojecttaskidintegerTeamprojecttaskid. Id only - teamprojecttask is read-only or has no code key.
parentcommentidintegerParentcommentid. Id only.
commenttextComment. Stored as text, no practical length limit.
cancelbooleanCancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-onlystringWhen the record was created.
lastchangedateread-onlystringLast modification. Drives modifiedsince.
externalidstring(100)Your own key. Scoped to your company.
When it fails
StatusCodeMeaning
404not_foundNo record with that id.
curl -X PATCH \
  'https://acme.nolapro.com/!/api/v2/teamprojectcomments/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "teamprojecttaskid": 104,
    "parentcommentid": 104,
    "comment": "Example comment"
}'
Response 200
{
    "teamprojecttaskid": 104,
    "parentcommentid": 104,
    "comment": "Example comment"
}
DELETE/teamprojectcomments/{id} 200404

Cancel.

Requires scope projects:cancel.

Parameters
NameInTypeNotes
idrequiredpathintegerThe record id.
When it fails
StatusCodeMeaning
404not_foundNo record with that id.
curl -X DELETE \
  'https://acme.nolapro.com/!/api/v2/teamprojectcomments/104' \
  -H 'Authorization: Bearer $NP_TOKEN'
Response 200
{
    "teamprojecttaskid": 104,
    "parentcommentid": 104,
    "comment": "Example comment"
}