Recurring tasks

Recurring task definitions, generated by the processqueue cron.

Licensed feature

This resource needs the teamproject feature active on the install you are calling. Without that every endpoint here answers 403 with feature_not_licensed - that is a licensing answer, not a permissions one, so check the company's features before the token's scopes.

The object#

FieldTypeDescription
idread-onlyintegerNolaPro id.
teamprojectidintegerReference to teamprojects, by id. Write either this or teamproject.
teamprojectstring(30)Code for the referenced teamproject, instead of the id.
teamprojectmilestoneidintegerTeamprojectmilestoneid. Id only - teamprojectmilestone is read-only or has no code key.
titlestring(255)Title given to each generated task.
descriptiontextDescription. Stored as text, no practical length limit.
teamprojectstatusidintegerReference to teamprojectstatuses, by id. Write either this or teamprojectstatus.
teamprojectstatusstring(100)Code for the referenced teamprojectstatus, instead of the id.
priorityintegerPriority of generated tasks: 0 = low, 1 = normal, 2 = high, 3 = critical.
estimatedhoursmoneystring(6dp)Stored as decimal(18,6).
assignuseridintegerReference to genusers, by id. Write either this or assignuser.
assignuserstring(50)Login name of the default assignee. Send this or assignuserid, not both unless they agree.
frequencyintegerHow often a task is generated: 0 = daily, 1 = weekly, 2 = monthly, 3 = custom (every intervaldays days).
intervaldaysintegerDays between generated tasks when frequency is custom.
dayofweekintegerDay of the week a weekly recurrence generates on (0 = Sunday).
dayofmonthintegerDay of the month a monthly recurrence generates on.
nextrundatestringNext date a task will be generated.
enddatestringDate the recurrence stops; empty runs indefinitely.
lastrundateread-onlystringWhen the recurrence last generated a task. Maintained by the generator, so it cannot be written through the API.
enabledbooleanTrue while the recurrence is active.
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/teamprojectrecurringtasks/batch 207

Create many.

Requires scope projects:write.

Parameters
NameInTypeNotes
Idempotency-KeyheaderstringMakes the write safely retryable. Any unique string per logical operation; a UUID is fine. The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing. The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers 409 idempotency_replay rather than silently handing back the old response. Keys are remembered for 24 hours.
Body array
FieldTypeDescription
idread-onlyintegerNolaPro id.
teamprojectidintegerReference to teamprojects, by id. Write either this or teamproject.
teamprojectstring(30)Code for the referenced teamproject, instead of the id.
teamprojectmilestoneidintegerTeamprojectmilestoneid. Id only - teamprojectmilestone is read-only or has no code key.
titlestring(255)Title given to each generated task.
descriptiontextDescription. Stored as text, no practical length limit.
teamprojectstatusidintegerReference to teamprojectstatuses, by id. Write either this or teamprojectstatus.
teamprojectstatusstring(100)Code for the referenced teamprojectstatus, instead of the id.
priorityintegerPriority of generated tasks: 0 = low, 1 = normal, 2 = high, 3 = critical.
estimatedhoursmoneystring(6dp)Stored as decimal(18,6).
assignuseridintegerReference to genusers, by id. Write either this or assignuser.
assignuserstring(50)Login name of the default assignee. Send this or assignuserid, not both unless they agree.
frequencyintegerHow often a task is generated: 0 = daily, 1 = weekly, 2 = monthly, 3 = custom (every intervaldays days).
intervaldaysintegerDays between generated tasks when frequency is custom.
dayofweekintegerDay of the week a weekly recurrence generates on (0 = Sunday).
dayofmonthintegerDay of the month a monthly recurrence generates on.
nextrundatestringNext date a task will be generated.
enddatestringDate the recurrence stops; empty runs indefinitely.
lastrundateread-onlystringWhen the recurrence last generated a task. Maintained by the generator, so it cannot be written through the API.
enabledbooleanTrue while the recurrence is active.
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.
curl -X POST \
  'https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "teamprojectid": 104,
        "teamproject": "Example teamproject",
        "teamprojectmilestoneid": 104,
        "title": "Example title",
        "description": "Example description",
        "teamprojectstatusid": 104
    }
]'
GET/teamprojectrecurringtasks 200403

List recurring tasks.

Requires scope projects:read.

Parameters
NameInTypeNotes
descriptionquerystringdescription. Partial match, case-insensitive.
titlequerystringPartial match, case insensitive.
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.
teamprojectidquerystringFilter to one .
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/teamprojectrecurringtasks' \
  -H 'Authorization: Bearer $NP_TOKEN'
POST/teamprojectrecurringtasks 201400

Create.

Requires scope projects:write.

Parameters
NameInTypeNotes
Idempotency-KeyheaderstringMakes the write safely retryable. Any unique string per logical operation; a UUID is fine. The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing. The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers 409 idempotency_replay rather than silently handing back the old response. Keys are remembered for 24 hours.
Body
FieldTypeDescription
idread-onlyintegerNolaPro id.
teamprojectidintegerReference to teamprojects, by id. Write either this or teamproject.
teamprojectstring(30)Code for the referenced teamproject, instead of the id.
teamprojectmilestoneidintegerTeamprojectmilestoneid. Id only - teamprojectmilestone is read-only or has no code key.
titlestring(255)Title given to each generated task.
descriptiontextDescription. Stored as text, no practical length limit.
teamprojectstatusidintegerReference to teamprojectstatuses, by id. Write either this or teamprojectstatus.
teamprojectstatusstring(100)Code for the referenced teamprojectstatus, instead of the id.
priorityintegerPriority of generated tasks: 0 = low, 1 = normal, 2 = high, 3 = critical.
estimatedhoursmoneystring(6dp)Stored as decimal(18,6).
assignuseridintegerReference to genusers, by id. Write either this or assignuser.
assignuserstring(50)Login name of the default assignee. Send this or assignuserid, not both unless they agree.
frequencyintegerHow often a task is generated: 0 = daily, 1 = weekly, 2 = monthly, 3 = custom (every intervaldays days).
intervaldaysintegerDays between generated tasks when frequency is custom.
dayofweekintegerDay of the week a weekly recurrence generates on (0 = Sunday).
dayofmonthintegerDay of the month a monthly recurrence generates on.
nextrundatestringNext date a task will be generated.
enddatestringDate the recurrence stops; empty runs indefinitely.
lastrundateread-onlystringWhen the recurrence last generated a task. Maintained by the generator, so it cannot be written through the API.
enabledbooleanTrue while the recurrence is active.
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
400invalid_requestA required field was missing.
curl -X POST \
  'https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "teamprojectid": 104,
    "teamproject": "Example teamproject",
    "teamprojectmilestoneid": 104,
    "title": "Example title",
    "description": "Example description",
    "teamprojectstatusid": 104
}'
Response 201
{
    "teamprojectid": 104,
    "teamproject": "Example teamproject",
    "teamprojectmilestoneid": 104,
    "title": "Example title",
    "description": "Example description",
    "teamprojectstatusid": 104
}
GET/teamprojectrecurringtasks/{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/teamprojectrecurringtasks/104' \
  -H 'Authorization: Bearer $NP_TOKEN'
Response 200
{
    "teamprojectid": 104,
    "teamproject": "Example teamproject",
    "teamprojectmilestoneid": 104,
    "title": "Example title",
    "description": "Example description",
    "teamprojectstatusid": 104
}
PATCH/teamprojectrecurringtasks/{id} 200404

Update.

Requires scope projects:write.

Parameters
NameInTypeNotes
idrequiredpathintegerThe record id.
Idempotency-KeyheaderstringMakes the write safely retryable. Any unique string per logical operation; a UUID is fine. The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing. The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers 409 idempotency_replay rather than silently handing back the old response. Keys are remembered for 24 hours.
Body
FieldTypeDescription
idread-onlyintegerNolaPro id.
teamprojectidintegerReference to teamprojects, by id. Write either this or teamproject.
teamprojectstring(30)Code for the referenced teamproject, instead of the id.
teamprojectmilestoneidintegerTeamprojectmilestoneid. Id only - teamprojectmilestone is read-only or has no code key.
titlestring(255)Title given to each generated task.
descriptiontextDescription. Stored as text, no practical length limit.
teamprojectstatusidintegerReference to teamprojectstatuses, by id. Write either this or teamprojectstatus.
teamprojectstatusstring(100)Code for the referenced teamprojectstatus, instead of the id.
priorityintegerPriority of generated tasks: 0 = low, 1 = normal, 2 = high, 3 = critical.
estimatedhoursmoneystring(6dp)Stored as decimal(18,6).
assignuseridintegerReference to genusers, by id. Write either this or assignuser.
assignuserstring(50)Login name of the default assignee. Send this or assignuserid, not both unless they agree.
frequencyintegerHow often a task is generated: 0 = daily, 1 = weekly, 2 = monthly, 3 = custom (every intervaldays days).
intervaldaysintegerDays between generated tasks when frequency is custom.
dayofweekintegerDay of the week a weekly recurrence generates on (0 = Sunday).
dayofmonthintegerDay of the month a monthly recurrence generates on.
nextrundatestringNext date a task will be generated.
enddatestringDate the recurrence stops; empty runs indefinitely.
lastrundateread-onlystringWhen the recurrence last generated a task. Maintained by the generator, so it cannot be written through the API.
enabledbooleanTrue while the recurrence is active.
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/teamprojectrecurringtasks/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "teamprojectid": 104,
    "teamproject": "Example teamproject",
    "teamprojectmilestoneid": 104,
    "title": "Example title",
    "description": "Example description",
    "teamprojectstatusid": 104
}'
Response 200
{
    "teamprojectid": 104,
    "teamproject": "Example teamproject",
    "teamprojectmilestoneid": 104,
    "title": "Example title",
    "description": "Example description",
    "teamprojectstatusid": 104
}
DELETE/teamprojectrecurringtasks/{id} 200404

Cancel.

Requires scope projects:cancel.

Parameters
NameInTypeNotes
idrequiredpathintegerThe record id.
Idempotency-KeyheaderstringMakes the write safely retryable. Any unique string per logical operation; a UUID is fine. The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing. The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers 409 idempotency_replay rather than silently handing back the old response. Keys are remembered for 24 hours.
When it fails
StatusCodeMeaning
404not_foundNo record with that id.
curl -X DELETE \
  'https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks/104' \
  -H 'Authorization: Bearer $NP_TOKEN'
Response 200
{
    "teamprojectid": 104,
    "teamproject": "Example teamproject",
    "teamprojectmilestoneid": 104,
    "title": "Example title",
    "description": "Example description",
    "teamprojectstatusid": 104
}