Milestones
Milestones within a project.
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. |
| name | string(200) | Milestone name. |
| description | text | Description. Stored as text, no practical length limit. |
| status | string | Status. Labels are Teamprojectmilestone_model::$statuses; stored as an int and never exposed or accepted as one (D35). One of pending, inprogress, completed, missed. |
| duedate | string | Date payment is due. |
| 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/teamprojectmilestones/batch
207
Create many.
Requires scope projects:write.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
Body array
| Field | Type | Description |
|---|---|---|
| name | string(200) | Milestone name. |
| description | text | Description. Stored as text, no practical length limit. |
| status | string | Status. Labels are Teamprojectmilestone_model::$statuses; stored as an int and never exposed or accepted as one (D35). One of pending, inprogress, completed, missed. |
| duedate | string | Date payment is due. |
| 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. |
| tasks | array of RefTeamprojecttasksCreate | Tasks created under this milestone, in order. Each is attached to the milestone once it has an 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. |
curl -X POST \ 'https://acme.nolapro.com/!/api/v2/teamprojectmilestones/batch' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: your-unique-key' \ -d '[ { "status": "pending", "tasks": [ { "priority": "low", "approvalstatus": "notrequested", "checklist": [ { "title": "Example title", "iscomplete": false, "sortorder": 1, "parentchecklistid": 104, "teamprojecttaskid": 104 } ], "assignees": [ { "genuser": "Example genuser", "teamprojecttaskid": 104 } ], "watchers": [ { "genuser": "Example genuser", "teamprojecttaskid": 104 } ], "tags": [ { "teamprojecttagid": 104, "teamprojecttag": "Example teamprojecttag", "teamprojecttaskid": 104 } ], "comments": [ { "parentcommentid": 104, "comment": "Example comment", "teamprojecttaskid": 104 } ] } ] } ]'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectmilestones/batch'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS => json_encode([ [ 'status' => 'pending', 'tasks' => [ [ 'priority' => 'low', 'approvalstatus' => 'notrequested', 'checklist' => [ [ 'title' => 'Example title', 'iscomplete' => false, 'sortorder' => 1, 'parentchecklistid' => 104, 'teamprojecttaskid' => 104, ], ], 'assignees' => [ [ 'genuser' => 'Example genuser', 'teamprojecttaskid' => 104, ], ], 'watchers' => [ [ 'genuser' => 'Example genuser', 'teamprojecttaskid' => 104, ], ], 'tags' => [ [ 'teamprojecttagid' => 104, 'teamprojecttag' => 'Example teamprojecttag', 'teamprojecttaskid' => 104, ], ], 'comments' => [ [ 'parentcommentid' => 104, 'comment' => 'Example comment', 'teamprojecttaskid' => 104, ], ], ], ], ], ]), ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.post( "https://acme.nolapro.com/!/api/v2/teamprojectmilestones/batch", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, json=[ { "status": "pending", "tasks": [ { "priority": "low", "approvalstatus": "notrequested", "checklist": [ { "title": "Example title", "iscomplete": False, "sortorder": 1, "parentchecklistid": 104, "teamprojecttaskid": 104, }, ], "assignees": [ { "genuser": "Example genuser", "teamprojecttaskid": 104, }, ], "watchers": [ { "genuser": "Example genuser", "teamprojecttaskid": 104, }, ], "tags": [ { "teamprojecttagid": 104, "teamprojecttag": "Example teamprojecttag", "teamprojecttaskid": 104, }, ], "comments": [ { "parentcommentid": 104, "comment": "Example comment", "teamprojecttaskid": 104, }, ], }, ], }, ], ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojectmilestones/batch', { method: 'POST', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, body: JSON.stringify([ { status: "pending", tasks: [ { priority: "low", approvalstatus: "notrequested", checklist: [ { title: "Example title", iscomplete: false, sortorder: 1, parentchecklistid: 104, teamprojecttaskid: 104, }, ], assignees: [ { genuser: "Example genuser", teamprojecttaskid: 104, }, ], watchers: [ { genuser: "Example genuser", teamprojecttaskid: 104, }, ], tags: [ { teamprojecttagid: 104, teamprojecttag: "Example teamprojecttag", teamprojecttaskid: 104, }, ], comments: [ { parentcommentid: 104, comment: "Example comment", teamprojecttaskid: 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 { status = "pending", tasks = new[] { new { priority = "low", approvalstatus = "notrequested", checklist = new[] { new { title = "Example title", iscomplete = false, sortorder = 1, parentchecklistid = 104, teamprojecttaskid = 104, }, }, assignees = new[] { new { genuser = "Example genuser", teamprojecttaskid = 104, }, }, watchers = new[] { new { genuser = "Example genuser", teamprojecttaskid = 104, }, }, tags = new[] { new { teamprojecttagid = 104, teamprojecttag = "Example teamprojecttag", teamprojecttaskid = 104, }, }, comments = new[] { new { parentcommentid = 104, comment = "Example comment", teamprojecttaskid = 104, }, }, }, }, }, }; var req = new HttpRequestMessage(HttpMethod.Post, "https://acme.nolapro.com/!/api/v2/teamprojectmilestones/batch") { Content = JsonContent.Create(body), }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
GET/teamprojectmilestones
200403
List milestones.
Requires scope projects:read.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
| status | query | string | Restrict to one status. |
| name | query | string | name. Partial match, case-insensitive. |
| description | query | string | description. 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/teamprojectmilestones' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectmilestones'); 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/teamprojectmilestones", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojectmilestones', { 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/teamprojectmilestones"); res.EnsureSuccessStatusCode();
POST/teamprojectmilestones
201400
Create.
Requires scope projects:write.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
Body
| Field | Type | Description |
|---|---|---|
| name | string(200) | Milestone name. |
| description | text | Description. Stored as text, no practical length limit. |
| status | string | Status. Labels are Teamprojectmilestone_model::$statuses; stored as an int and never exposed or accepted as one (D35). One of pending, inprogress, completed, missed. |
| duedate | string | Date payment is due. |
| 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. |
| tasks | array of RefTeamprojecttasksCreate | Tasks created under this milestone, in order. Each is attached to the milestone once it has an 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. |
When it fails
| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_request | A required field was missing. |
curl -X POST \ 'https://acme.nolapro.com/!/api/v2/teamprojectmilestones' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: your-unique-key' \ -d '{ "status": "pending", "tasks": [ { "priority": "low", "approvalstatus": "notrequested", "checklist": [ { "title": "Example title", "iscomplete": false, "sortorder": 1, "parentchecklistid": 104, "teamprojecttaskid": 104 } ], "assignees": [ { "genuser": "Example genuser", "teamprojecttaskid": 104 } ], "watchers": [ { "genuser": "Example genuser", "teamprojecttaskid": 104 } ], "tags": [ { "teamprojecttagid": 104, "teamprojecttag": "Example teamprojecttag", "teamprojecttaskid": 104 } ], "comments": [ { "parentcommentid": 104, "comment": "Example comment", "teamprojecttaskid": 104 } ] } ] }'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectmilestones'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS => json_encode([ 'status' => 'pending', 'tasks' => [ [ 'priority' => 'low', 'approvalstatus' => 'notrequested', 'checklist' => [ [ 'title' => 'Example title', 'iscomplete' => false, 'sortorder' => 1, 'parentchecklistid' => 104, 'teamprojecttaskid' => 104, ], ], 'assignees' => [ [ 'genuser' => 'Example genuser', 'teamprojecttaskid' => 104, ], ], 'watchers' => [ [ 'genuser' => 'Example genuser', 'teamprojecttaskid' => 104, ], ], 'tags' => [ [ 'teamprojecttagid' => 104, 'teamprojecttag' => 'Example teamprojecttag', 'teamprojecttaskid' => 104, ], ], 'comments' => [ [ 'parentcommentid' => 104, 'comment' => 'Example comment', 'teamprojecttaskid' => 104, ], ], ], ], ]), ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.post( "https://acme.nolapro.com/!/api/v2/teamprojectmilestones", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, json={ "status": "pending", "tasks": [ { "priority": "low", "approvalstatus": "notrequested", "checklist": [ { "title": "Example title", "iscomplete": False, "sortorder": 1, "parentchecklistid": 104, "teamprojecttaskid": 104, }, ], "assignees": [ { "genuser": "Example genuser", "teamprojecttaskid": 104, }, ], "watchers": [ { "genuser": "Example genuser", "teamprojecttaskid": 104, }, ], "tags": [ { "teamprojecttagid": 104, "teamprojecttag": "Example teamprojecttag", "teamprojecttaskid": 104, }, ], "comments": [ { "parentcommentid": 104, "comment": "Example comment", "teamprojecttaskid": 104, }, ], }, ], }, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojectmilestones', { method: 'POST', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, body: JSON.stringify({ status: "pending", tasks: [ { priority: "low", approvalstatus: "notrequested", checklist: [ { title: "Example title", iscomplete: false, sortorder: 1, parentchecklistid: 104, teamprojecttaskid: 104, }, ], assignees: [ { genuser: "Example genuser", teamprojecttaskid: 104, }, ], watchers: [ { genuser: "Example genuser", teamprojecttaskid: 104, }, ], tags: [ { teamprojecttagid: 104, teamprojecttag: "Example teamprojecttag", teamprojecttaskid: 104, }, ], comments: [ { parentcommentid: 104, comment: "Example comment", teamprojecttaskid: 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 { status = "pending", tasks = new[] { new { priority = "low", approvalstatus = "notrequested", checklist = new[] { new { title = "Example title", iscomplete = false, sortorder = 1, parentchecklistid = 104, teamprojecttaskid = 104, }, }, assignees = new[] { new { genuser = "Example genuser", teamprojecttaskid = 104, }, }, watchers = new[] { new { genuser = "Example genuser", teamprojecttaskid = 104, }, }, tags = new[] { new { teamprojecttagid = 104, teamprojecttag = "Example teamprojecttag", teamprojecttaskid = 104, }, }, comments = new[] { new { parentcommentid = 104, comment = "Example comment", teamprojecttaskid = 104, }, }, }, }, }; var req = new HttpRequestMessage(HttpMethod.Post, "https://acme.nolapro.com/!/api/v2/teamprojectmilestones") { Content = JsonContent.Create(body), }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
Response 201
{
"status": "pending"
}
GET/teamprojectmilestones/{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/teamprojectmilestones/104' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectmilestones/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/teamprojectmilestones/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojectmilestones/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/teamprojectmilestones/104"); res.EnsureSuccessStatusCode();
Response 200
{
"status": "pending"
}
PATCH/teamprojectmilestones/{id}
200404
Update.
Only the fields you send change. Children cannot be sent here - milestones and tasks are create-only (see Conventions). Use the child resource to add, change or cancel one.
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. |
| name | string(200) | Milestone name. |
| description | text | Description. Stored as text, no practical length limit. |
| status | string | Status. Labels are Teamprojectmilestone_model::$statuses; stored as an int and never exposed or accepted as one (D35). One of pending, inprogress, completed, missed. |
| duedate | string | Date payment is due. |
| 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/teamprojectmilestones/104' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: your-unique-key' \ -d '{ "status": "pending" }'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectmilestones/104'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'PATCH', CURLOPT_POSTFIELDS => json_encode([ 'status' => 'pending', ]), ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.patch( "https://acme.nolapro.com/!/api/v2/teamprojectmilestones/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, json={ "status": "pending", }, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojectmilestones/104', { method: 'PATCH', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, body: JSON.stringify({ status: "pending", }), } ); 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 { status = "pending", }; var req = new HttpRequestMessage(HttpMethod.Patch, "https://acme.nolapro.com/!/api/v2/teamprojectmilestones/104") { Content = JsonContent.Create(body), }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
Response 200
{
"status": "pending"
}
DELETE/teamprojectmilestones/{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/teamprojectmilestones/104' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectmilestones/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/teamprojectmilestones/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojectmilestones/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/teamprojectmilestones/104"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
Response 200
{
"status": "pending"
}