Recurring tasks

Recurring task definitions, generated by the processqueue cron.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
teamprojectid	integer	Reference to `teamprojects`, by id. Write either this or `teamproject`.
teamproject	string(30)	Code for the referenced teamproject, instead of the id.
teamprojectmilestoneid	integer	Teamprojectmilestoneid. Id only - `teamprojectmilestone` is read-only or has no code key.
title	string(255)	Title given to each generated task.
description	text	Description. Stored as `text`, no practical length limit.
teamprojectstatusid	integer	Reference to `teamprojectstatuses`, by id. Write either this or `teamprojectstatus`.
teamprojectstatus	string(100)	Code for the referenced teamprojectstatus, instead of the id.
priority	integer	Priority of generated tasks: 0 = low, 1 = normal, 2 = high, 3 = critical.
estimatedhoursmoney	string(6dp)	Stored as `decimal(18,6)`.
assignuserid	integer	Reference to `genusers`, by id. Write either this or `assignuser`.
assignuser	string(50)	Login name of the default assignee. Send this or `assignuserid`, not both unless they agree.
frequency	integer	How often a task is generated: 0 = daily, 1 = weekly, 2 = monthly, 3 = custom (every `intervaldays` days).
intervaldays	integer	Days between generated tasks when `frequency` is custom.
dayofweek	integer	Day of the week a weekly recurrence generates on (0 = Sunday).
dayofmonth	integer	Day of the month a monthly recurrence generates on.
nextrundate	string	Next date a task will be generated.
enddate	string	Date the recurrence stops; empty runs indefinitely.
lastrundateread-only	string	When the recurrence last generated a task. Maintained by the generator, so it cannot be written through the API.
enabled	boolean	True while the recurrence is active.
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/teamprojectrecurringtasks/batch 207

Create many.

Requires scope projects:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
teamprojectid	integer	Reference to `teamprojects`, by id. Write either this or `teamproject`.
teamproject	string(30)	Code for the referenced teamproject, instead of the id.
teamprojectmilestoneid	integer	Teamprojectmilestoneid. Id only - `teamprojectmilestone` is read-only or has no code key.
title	string(255)	Title given to each generated task.
description	text	Description. Stored as `text`, no practical length limit.
teamprojectstatusid	integer	Reference to `teamprojectstatuses`, by id. Write either this or `teamprojectstatus`.
teamprojectstatus	string(100)	Code for the referenced teamprojectstatus, instead of the id.
priority	integer	Priority of generated tasks: 0 = low, 1 = normal, 2 = high, 3 = critical.
estimatedhoursmoney	string(6dp)	Stored as `decimal(18,6)`.
assignuserid	integer	Reference to `genusers`, by id. Write either this or `assignuser`.
assignuser	string(50)	Login name of the default assignee. Send this or `assignuserid`, not both unless they agree.
frequency	integer	How often a task is generated: 0 = daily, 1 = weekly, 2 = monthly, 3 = custom (every `intervaldays` days).
intervaldays	integer	Days between generated tasks when `frequency` is custom.
dayofweek	integer	Day of the week a weekly recurrence generates on (0 = Sunday).
dayofmonth	integer	Day of the month a monthly recurrence generates on.
nextrundate	string	Next date a task will be generated.
enddate	string	Date the recurrence stops; empty runs indefinitely.
lastrundateread-only	string	When the recurrence last generated a task. Maintained by the generator, so it cannot be written through the API.
enabled	boolean	True while the recurrence is active.
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
externalid	string(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
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'teamprojectid' => 104,
      'teamproject' => 'Example teamproject',
      'teamprojectmilestoneid' => 104,
      'title' => 'Example title',
      'description' => 'Example description',
      'teamprojectstatusid' => 104,
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "teamprojectid": 104,
            "teamproject": "Example teamproject",
            "teamprojectmilestoneid": 104,
            "title": "Example title",
            "description": "Example description",
            "teamprojectstatusid": 104,
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        teamprojectid: 104,
        teamproject: "Example teamproject",
        teamprojectmilestoneid: 104,
        title: "Example title",
        description: "Example description",
        teamprojectstatusid: 104,
      },
    ]),
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var body = new[] {
    new {
        teamprojectid = 104,
        teamproject = "Example teamproject",
        teamprojectmilestoneid = 104,
        title = "Example title",
        description = "Example description",
        teamprojectstatusid = 104,
    },
};

var req = new HttpRequestMessage(HttpMethod.Post,
    "https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks/batch") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

GET/teamprojectrecurringtasks 200403

List recurring tasks.

Requires scope projects:read.

Parameters

Name	In	Type	Notes
description	query	string	description. Partial match, case-insensitive.
title	query	string	Partial match, case insensitive.
cancel	query	string	Defaults to `false`. Pass `true` or `any`.
modifiedsince	query	string	RFC 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.
externalid	query	string	Exact match on your own key.
teamprojectid	query	string	Filter to one .
include	query	string	Comma-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

Status	Code	Meaning
403	insufficient_scope	Token lacks read scope.

curl \
  'https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.get(
    "https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks',
  {
    method: 'GET',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var res = await http.GetAsync(
    "https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks");
res.EnsureSuccessStatusCode();

POST/teamprojectrecurringtasks 201400

Create.

Requires scope projects:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
teamprojectid	integer	Reference to `teamprojects`, by id. Write either this or `teamproject`.
teamproject	string(30)	Code for the referenced teamproject, instead of the id.
teamprojectmilestoneid	integer	Teamprojectmilestoneid. Id only - `teamprojectmilestone` is read-only or has no code key.
title	string(255)	Title given to each generated task.
description	text	Description. Stored as `text`, no practical length limit.
teamprojectstatusid	integer	Reference to `teamprojectstatuses`, by id. Write either this or `teamprojectstatus`.
teamprojectstatus	string(100)	Code for the referenced teamprojectstatus, instead of the id.
priority	integer	Priority of generated tasks: 0 = low, 1 = normal, 2 = high, 3 = critical.
estimatedhoursmoney	string(6dp)	Stored as `decimal(18,6)`.
assignuserid	integer	Reference to `genusers`, by id. Write either this or `assignuser`.
assignuser	string(50)	Login name of the default assignee. Send this or `assignuserid`, not both unless they agree.
frequency	integer	How often a task is generated: 0 = daily, 1 = weekly, 2 = monthly, 3 = custom (every `intervaldays` days).
intervaldays	integer	Days between generated tasks when `frequency` is custom.
dayofweek	integer	Day of the week a weekly recurrence generates on (0 = Sunday).
dayofmonth	integer	Day of the month a monthly recurrence generates on.
nextrundate	string	Next date a task will be generated.
enddate	string	Date the recurrence stops; empty runs indefinitely.
lastrundateread-only	string	When the recurrence last generated a task. Maintained by the generator, so it cannot be written through the API.
enabled	boolean	True while the recurrence is active.
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
externalid	string(100)	Your own key. Scoped to your company.

When it fails

Status	Code	Meaning
400	invalid_request	A 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
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'teamprojectid' => 104,
    'teamproject' => 'Example teamproject',
    'teamprojectmilestoneid' => 104,
    'title' => 'Example title',
    'description' => 'Example description',
    'teamprojectstatusid' => 104,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "teamprojectid": 104,
        "teamproject": "Example teamproject",
        "teamprojectmilestoneid": 104,
        "title": "Example title",
        "description": "Example description",
        "teamprojectstatusid": 104,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      teamprojectid: 104,
      teamproject: "Example teamproject",
      teamprojectmilestoneid: 104,
      title: "Example title",
      description: "Example description",
      teamprojectstatusid: 104,
    }),
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var body = new {
    teamprojectid = 104,
    teamproject = "Example teamproject",
    teamprojectmilestoneid = 104,
    title = "Example title",
    description = "Example description",
    teamprojectstatusid = 104,
};

var req = new HttpRequestMessage(HttpMethod.Post,
    "https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

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

Name	In	Type	Notes
idrequired	path	integer	The record id.
include	query	string	Comma-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

Status	Code	Meaning
404	not_found	No record with that id.

curl \
  'https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.get(
    "https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks/104',
  {
    method: 'GET',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var res = await http.GetAsync(
    "https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks/104");
res.EnsureSuccessStatusCode();

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

Name	In	Type	Notes
idrequired	path	integer	The record id.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
teamprojectid	integer	Reference to `teamprojects`, by id. Write either this or `teamproject`.
teamproject	string(30)	Code for the referenced teamproject, instead of the id.
teamprojectmilestoneid	integer	Teamprojectmilestoneid. Id only - `teamprojectmilestone` is read-only or has no code key.
title	string(255)	Title given to each generated task.
description	text	Description. Stored as `text`, no practical length limit.
teamprojectstatusid	integer	Reference to `teamprojectstatuses`, by id. Write either this or `teamprojectstatus`.
teamprojectstatus	string(100)	Code for the referenced teamprojectstatus, instead of the id.
priority	integer	Priority of generated tasks: 0 = low, 1 = normal, 2 = high, 3 = critical.
estimatedhoursmoney	string(6dp)	Stored as `decimal(18,6)`.
assignuserid	integer	Reference to `genusers`, by id. Write either this or `assignuser`.
assignuser	string(50)	Login name of the default assignee. Send this or `assignuserid`, not both unless they agree.
frequency	integer	How often a task is generated: 0 = daily, 1 = weekly, 2 = monthly, 3 = custom (every `intervaldays` days).
intervaldays	integer	Days between generated tasks when `frequency` is custom.
dayofweek	integer	Day of the week a weekly recurrence generates on (0 = Sunday).
dayofmonth	integer	Day of the month a monthly recurrence generates on.
nextrundate	string	Next date a task will be generated.
enddate	string	Date the recurrence stops; empty runs indefinitely.
lastrundateread-only	string	When the recurrence last generated a task. Maintained by the generator, so it cannot be written through the API.
enabled	boolean	True while the recurrence is active.
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
externalid	string(100)	Your own key. Scoped to your company.

When it fails

Status	Code	Meaning
404	not_found	No 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
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'teamprojectid' => 104,
    'teamproject' => 'Example teamproject',
    'teamprojectmilestoneid' => 104,
    'title' => 'Example title',
    'description' => 'Example description',
    'teamprojectstatusid' => 104,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "teamprojectid": 104,
        "teamproject": "Example teamproject",
        "teamprojectmilestoneid": 104,
        "title": "Example title",
        "description": "Example description",
        "teamprojectstatusid": 104,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      teamprojectid: 104,
      teamproject: "Example teamproject",
      teamprojectmilestoneid: 104,
      title: "Example title",
      description: "Example description",
      teamprojectstatusid: 104,
    }),
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var body = new {
    teamprojectid = 104,
    teamproject = "Example teamproject",
    teamprojectmilestoneid = 104,
    title = "Example title",
    description = "Example description",
    teamprojectstatusid = 104,
};

var req = new HttpRequestMessage(HttpMethod.Patch,
    "https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks/104") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

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

Name	In	Type	Notes
idrequired	path	integer	The record id.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.

curl -X DELETE \
  'https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'DELETE',
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.delete(
    "https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks/104',
  {
    method: 'DELETE',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var req = new HttpRequestMessage(HttpMethod.Delete,
    "https://acme.nolapro.com/!/api/v2/teamprojectrecurringtasks/104");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 200

{
    "teamprojectid": 104,
    "teamproject": "Example teamproject",
    "teamprojectmilestoneid": 104,
    "title": "Example title",
    "description": "Example description",
    "teamprojectstatusid": 104
}

Automations →

Rules that act on project events.

Project templates →

Saved project templates.