Template items

Milestones and tasks inside a template.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
teamprojecttemplateid	integer	Reference to `teamprojecttemplates`, by id. Write either this or `teamprojecttemplate`.
teamprojecttemplate	string(100)	Code for the referenced teamprojecttemplate, instead of the id.
parentitemid	integer	Parentitemid. Id only.
parentitem	string(255)	The `sku` of the referenced items, instead of the id. Send this or `parentitemid`, not both unless they agree.
itemtype	integer	What the template item creates: 0 = milestone, 1 = task.
title	string(255)	Title given to the created task or milestone.
description	text	Description. Stored as `text`, no practical length limit.
priority	integer	Priority of the created task: 0 = low, 1 = normal, 2 = high, 3 = critical.
estimatedhoursmoney	string(6dp)	Stored as `decimal(18,6)`.
offsetdays	integer	Days after the project start that the item begins.
durationdays	integer	How many days the item runs; sets its due date.
assignrole	boolean	True assigns the created task by project role rather than to a specific user.
sortorder	integer	Display order. Lower sorts first.
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/teamprojecttemplateitems/batch 207

Create many.

Requires scope projects:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
teamprojecttemplate	string(100)	Code for the referenced teamprojecttemplate, instead of the id.
parentitemid	integer	Parentitemid. Id only.
itemtype	integer	What the template item creates: 0 = milestone, 1 = task.
title	string(255)	Title given to the created task or milestone.
description	text	Description. Stored as `text`, no practical length limit.
priority	integer	Priority of the created task: 0 = low, 1 = normal, 2 = high, 3 = critical.
estimatedhoursmoney	string(6dp)	Stored as `decimal(18,6)`.
offsetdays	integer	Days after the project start that the item begins.
durationdays	integer	How many days the item runs; sets its due date.
assignrole	boolean	True assigns the created task by project role rather than to a specific user.
sortorder	integer	Display order. Lower sorts first.
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-only	string	When the record was created.
externalid	string(100)	Your own key. Scoped to your company.
teamprojecttemplateid	integer	Reference to `teamprojecttemplates`, by id. Write either this or `teamprojecttemplate`.
parentitem	string(255)	The `sku` of the referenced items, instead of the id. Send this or `parentitemid`, not both unless they agree.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/teamprojecttemplateitems/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "teamprojecttemplate": "Example teamprojecttemplate",
        "parentitemid": 104,
        "itemtype": 1,
        "title": "Example title",
        "description": "Example description",
        "priority": 1
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojecttemplateitems/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'teamprojecttemplate' => 'Example teamprojecttemplate',
      'parentitemid' => 104,
      'itemtype' => 1,
      'title' => 'Example title',
      'description' => 'Example description',
      'priority' => 1,
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/teamprojecttemplateitems/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "teamprojecttemplate": "Example teamprojecttemplate",
            "parentitemid": 104,
            "itemtype": 1,
            "title": "Example title",
            "description": "Example description",
            "priority": 1,
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojecttemplateitems/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        teamprojecttemplate: "Example teamprojecttemplate",
        parentitemid: 104,
        itemtype: 1,
        title: "Example title",
        description: "Example description",
        priority: 1,
      },
    ]),
  }
);
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 {
        teamprojecttemplate = "Example teamprojecttemplate",
        parentitemid = 104,
        itemtype = 1,
        title = "Example title",
        description = "Example description",
        priority = 1,
    },
};

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

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

GET/teamprojecttemplateitems 200403

List template items.

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.
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/teamprojecttemplateitems' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojecttemplateitems');
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/teamprojecttemplateitems",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojecttemplateitems',
  {
    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/teamprojecttemplateitems");
res.EnsureSuccessStatusCode();

POST/teamprojecttemplateitems 201400

Create.

Requires scope projects:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
teamprojecttemplate	string(100)	Code for the referenced teamprojecttemplate, instead of the id.
parentitemid	integer	Parentitemid. Id only.
itemtype	integer	What the template item creates: 0 = milestone, 1 = task.
title	string(255)	Title given to the created task or milestone.
description	text	Description. Stored as `text`, no practical length limit.
priority	integer	Priority of the created task: 0 = low, 1 = normal, 2 = high, 3 = critical.
estimatedhoursmoney	string(6dp)	Stored as `decimal(18,6)`.
offsetdays	integer	Days after the project start that the item begins.
durationdays	integer	How many days the item runs; sets its due date.
assignrole	boolean	True assigns the created task by project role rather than to a specific user.
sortorder	integer	Display order. Lower sorts first.
cancel	boolean	Cancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-only	string	When the record was created.
externalid	string(100)	Your own key. Scoped to your company.
teamprojecttemplateid	integer	Reference to `teamprojecttemplates`, by id. Write either this or `teamprojecttemplate`.
parentitem	string(255)	The `sku` of the referenced items, instead of the id. Send this or `parentitemid`, not both unless they agree.

When it fails

Status	Code	Meaning
400	invalid_request	A required field was missing.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/teamprojecttemplateitems' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "teamprojecttemplate": "Example teamprojecttemplate",
    "parentitemid": 104,
    "itemtype": 1,
    "title": "Example title",
    "description": "Example description",
    "priority": 1
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojecttemplateitems');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'teamprojecttemplate' => 'Example teamprojecttemplate',
    'parentitemid' => 104,
    'itemtype' => 1,
    'title' => 'Example title',
    'description' => 'Example description',
    'priority' => 1,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/teamprojecttemplateitems",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "teamprojecttemplate": "Example teamprojecttemplate",
        "parentitemid": 104,
        "itemtype": 1,
        "title": "Example title",
        "description": "Example description",
        "priority": 1,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojecttemplateitems',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      teamprojecttemplate: "Example teamprojecttemplate",
      parentitemid: 104,
      itemtype: 1,
      title: "Example title",
      description: "Example description",
      priority: 1,
    }),
  }
);
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 {
    teamprojecttemplate = "Example teamprojecttemplate",
    parentitemid = 104,
    itemtype = 1,
    title = "Example title",
    description = "Example description",
    priority = 1,
};

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

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

Response 201

{
    "teamprojecttemplateid": 104,
    "teamprojecttemplate": "Example teamprojecttemplate",
    "parentitemid": 104,
    "parentitem": "Example parentitem",
    "itemtype": 1,
    "title": "Example title"
}

GET/teamprojecttemplateitems/{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/teamprojecttemplateitems/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojecttemplateitems/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/teamprojecttemplateitems/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojecttemplateitems/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/teamprojecttemplateitems/104");
res.EnsureSuccessStatusCode();

Response 200

{
    "teamprojecttemplateid": 104,
    "teamprojecttemplate": "Example teamprojecttemplate",
    "parentitemid": 104,
    "parentitem": "Example parentitem",
    "itemtype": 1,
    "title": "Example title"
}

PATCH/teamprojecttemplateitems/{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.
teamprojecttemplateid	integer	Reference to `teamprojecttemplates`, by id. Write either this or `teamprojecttemplate`.
teamprojecttemplate	string(100)	Code for the referenced teamprojecttemplate, instead of the id.
parentitemid	integer	Parentitemid. Id only.
parentitem	string(255)	The `sku` of the referenced items, instead of the id. Send this or `parentitemid`, not both unless they agree.
itemtype	integer	What the template item creates: 0 = milestone, 1 = task.
title	string(255)	Title given to the created task or milestone.
description	text	Description. Stored as `text`, no practical length limit.
priority	integer	Priority of the created task: 0 = low, 1 = normal, 2 = high, 3 = critical.
estimatedhoursmoney	string(6dp)	Stored as `decimal(18,6)`.
offsetdays	integer	Days after the project start that the item begins.
durationdays	integer	How many days the item runs; sets its due date.
assignrole	boolean	True assigns the created task by project role rather than to a specific user.
sortorder	integer	Display order. Lower sorts first.
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/teamprojecttemplateitems/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "teamprojecttemplateid": 104,
    "teamprojecttemplate": "Example teamprojecttemplate",
    "parentitemid": 104,
    "parentitem": "Example parentitem",
    "itemtype": 1,
    "title": "Example title"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojecttemplateitems/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'teamprojecttemplateid' => 104,
    'teamprojecttemplate' => 'Example teamprojecttemplate',
    'parentitemid' => 104,
    'parentitem' => 'Example parentitem',
    'itemtype' => 1,
    'title' => 'Example title',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/teamprojecttemplateitems/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "teamprojecttemplateid": 104,
        "teamprojecttemplate": "Example teamprojecttemplate",
        "parentitemid": 104,
        "parentitem": "Example parentitem",
        "itemtype": 1,
        "title": "Example title",
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojecttemplateitems/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      teamprojecttemplateid: 104,
      teamprojecttemplate: "Example teamprojecttemplate",
      parentitemid: 104,
      parentitem: "Example parentitem",
      itemtype: 1,
      title: "Example title",
    }),
  }
);
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 {
    teamprojecttemplateid = 104,
    teamprojecttemplate = "Example teamprojecttemplate",
    parentitemid = 104,
    parentitem = "Example parentitem",
    itemtype = 1,
    title = "Example title",
};

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

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

Response 200

{
    "teamprojecttemplateid": 104,
    "teamprojecttemplate": "Example teamprojecttemplate",
    "parentitemid": 104,
    "parentitem": "Example parentitem",
    "itemtype": 1,
    "title": "Example title"
}

DELETE/teamprojecttemplateitems/{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/teamprojecttemplateitems/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojecttemplateitems/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/teamprojecttemplateitems/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojecttemplateitems/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/teamprojecttemplateitems/104");

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

Response 200

{
    "teamprojecttemplateid": 104,
    "teamprojecttemplate": "Example teamprojecttemplate",
    "parentitemid": 104,
    "parentitem": "Example parentitem",
    "itemtype": 1,
    "title": "Example title"
}

Saved views →

Saved board and list views.

Project settings →

Module settings, key/value.