Task watchers
Who gets notified about a task.
The object#
| Field | Type | Description |
|---|---|---|
| idread-only | integer | NolaPro id. |
| teamprojecttaskid | integer | Teamprojecttaskid. Id only - teamprojecttask is read-only or has no code key. |
| genuserid | integer | Genuserid. Id only - genuser is read-only or has no code key. |
| genuser | string(50) | Login name of the watcher. Send this or genuserid, not both unless they agree. |
| 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/teamprojecttaskwatchers/batch
207
Create many.
Requires scope projects:write.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
Body array
| Field | Type | Description |
|---|---|---|
| genuserid | integer | Genuserid. Id only - genuser is read-only or has no code key. |
| genuser | string(50) | Login name of the watcher. Send this or genuserid, not both unless they agree. |
| 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. |
| teamprojecttaskid | integer | Teamprojecttaskid. Id only - teamprojecttask is read-only or has no code key. |
curl -X POST \ 'https://acme.nolapro.com/!/api/v2/teamprojecttaskwatchers/batch' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: your-unique-key' \ -d '[ { "genuser": "Example genuser", "teamprojecttaskid": 104 } ]'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojecttaskwatchers/batch'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS => json_encode([ [ 'genuser' => 'Example genuser', 'teamprojecttaskid' => 104, ], ]), ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.post( "https://acme.nolapro.com/!/api/v2/teamprojecttaskwatchers/batch", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, json=[ { "genuser": "Example genuser", "teamprojecttaskid": 104, }, ], ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojecttaskwatchers/batch', { method: 'POST', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, body: JSON.stringify([ { genuser: "Example genuser", 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 { genuser = "Example genuser", teamprojecttaskid = 104, }, }; var req = new HttpRequestMessage(HttpMethod.Post, "https://acme.nolapro.com/!/api/v2/teamprojecttaskwatchers/batch") { Content = JsonContent.Create(body), }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
GET/teamprojecttaskwatchers
200403
List task watchers.
Requires scope projects:read.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
| genuserid | query | string | Restrict to one genuserid. |
| 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. |
| teamprojecttaskid | query | string | Filter to one task. |
| 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/teamprojecttaskwatchers' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojecttaskwatchers'); 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/teamprojecttaskwatchers", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojecttaskwatchers', { 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/teamprojecttaskwatchers"); res.EnsureSuccessStatusCode();
POST/teamprojecttaskwatchers
201400
Create.
Requires scope projects:write.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
Body
| Field | Type | Description |
|---|---|---|
| genuserid | integer | Genuserid. Id only - genuser is read-only or has no code key. |
| genuser | string(50) | Login name of the watcher. Send this or genuserid, not both unless they agree. |
| 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. |
| teamprojecttaskid | integer | Teamprojecttaskid. Id only - teamprojecttask is read-only or has no code key. |
When it fails
| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_request | A required field was missing. |
curl -X POST \ 'https://acme.nolapro.com/!/api/v2/teamprojecttaskwatchers' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: your-unique-key' \ -d '{ "genuser": "Example genuser", "teamprojecttaskid": 104 }'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojecttaskwatchers'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS => json_encode([ 'genuser' => 'Example genuser', 'teamprojecttaskid' => 104, ]), ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.post( "https://acme.nolapro.com/!/api/v2/teamprojecttaskwatchers", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, json={ "genuser": "Example genuser", "teamprojecttaskid": 104, }, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojecttaskwatchers', { method: 'POST', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, body: JSON.stringify({ genuser: "Example genuser", 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 { genuser = "Example genuser", teamprojecttaskid = 104, }; var req = new HttpRequestMessage(HttpMethod.Post, "https://acme.nolapro.com/!/api/v2/teamprojecttaskwatchers") { Content = JsonContent.Create(body), }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
Response 201
{
"teamprojecttaskid": 104,
"genuser": "Example genuser"
}
GET/teamprojecttaskwatchers/{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/teamprojecttaskwatchers/104' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojecttaskwatchers/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/teamprojecttaskwatchers/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojecttaskwatchers/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/teamprojecttaskwatchers/104"); res.EnsureSuccessStatusCode();
Response 200
{
"teamprojecttaskid": 104,
"genuser": "Example genuser"
}
PATCH/teamprojecttaskwatchers/{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. |
| teamprojecttaskid | integer | Teamprojecttaskid. Id only - teamprojecttask is read-only or has no code key. |
| genuserid | integer | Genuserid. Id only - genuser is read-only or has no code key. |
| genuser | string(50) | Login name of the watcher. Send this or genuserid, not both unless they agree. |
| 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/teamprojecttaskwatchers/104' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: your-unique-key' \ -d '{ "teamprojecttaskid": 104, "genuser": "Example genuser" }'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojecttaskwatchers/104'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'PATCH', CURLOPT_POSTFIELDS => json_encode([ 'teamprojecttaskid' => 104, 'genuser' => 'Example genuser', ]), ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.patch( "https://acme.nolapro.com/!/api/v2/teamprojecttaskwatchers/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, json={ "teamprojecttaskid": 104, "genuser": "Example genuser", }, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojecttaskwatchers/104', { method: 'PATCH', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, body: JSON.stringify({ teamprojecttaskid: 104, genuser: "Example genuser", }), } ); 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 { teamprojecttaskid = 104, genuser = "Example genuser", }; var req = new HttpRequestMessage(HttpMethod.Patch, "https://acme.nolapro.com/!/api/v2/teamprojecttaskwatchers/104") { Content = JsonContent.Create(body), }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
Response 200
{
"teamprojecttaskid": 104,
"genuser": "Example genuser"
}
DELETE/teamprojecttaskwatchers/{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/teamprojecttaskwatchers/104' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojecttaskwatchers/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/teamprojecttaskwatchers/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/teamprojecttaskwatchers/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/teamprojecttaskwatchers/104"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
Response 200
{
"teamprojecttaskid": 104,
"genuser": "Example genuser"
}