Milestones

Milestones within a project.

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.
namestring(200)Milestone name.
descriptiontextDescription. Stored as text, no practical length limit.
statusstringStatus. Labels are Teamprojectmilestone_model::$statuses; stored as an int and never exposed or accepted as one (D35). One of pending, inprogress, completed, missed.
duedatestringDate payment is due.
sortorderintegerDisplay order. Lower sorts first.
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/teamprojectmilestones/batch 207

Create many.

Requires scope projects:write.

Parameters
NameInTypeNotes
Body array
FieldTypeDescription
namestring(200)Milestone name.
descriptiontextDescription. Stored as text, no practical length limit.
statusstringStatus. Labels are Teamprojectmilestone_model::$statuses; stored as an int and never exposed or accepted as one (D35). One of pending, inprogress, completed, missed.
duedatestringDate payment is due.
sortorderintegerDisplay order. Lower sorts first.
cancelbooleanCancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-onlystringWhen the record was created.
externalidstring(100)Your own key. Scoped to your company.
tasksarray of RefTeamprojecttasksCreateTasks created under this milestone, in order. Each is attached to the milestone once it has an id.
teamprojectidintegerReference to teamprojects, by id. Write either this or teamproject.
teamprojectstring(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
                    }
                ]
            }
        ]
    }
]'
GET/teamprojectmilestones 200403

List milestones.

Requires scope projects:read.

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

Create.

Requires scope projects:write.

Parameters
NameInTypeNotes
Body
FieldTypeDescription
namestring(200)Milestone name.
descriptiontextDescription. Stored as text, no practical length limit.
statusstringStatus. Labels are Teamprojectmilestone_model::$statuses; stored as an int and never exposed or accepted as one (D35). One of pending, inprogress, completed, missed.
duedatestringDate payment is due.
sortorderintegerDisplay order. Lower sorts first.
cancelbooleanCancelled. NolaPro cancels rather than deletes, so a cancelled row is still readable.
entrydateread-onlystringWhen the record was created.
externalidstring(100)Your own key. Scoped to your company.
tasksarray of RefTeamprojecttasksCreateTasks created under this milestone, in order. Each is attached to the milestone once it has an id.
teamprojectidintegerReference to teamprojects, by id. Write either this or teamproject.
teamprojectstring(30)Code for the referenced teamproject, instead of the id.
When it fails
StatusCodeMeaning
400invalid_requestA 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
                }
            ]
        }
    ]
}'
Response 201
{
    "status": "pending"
}
GET/teamprojectmilestones/{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/teamprojectmilestones/104' \
  -H 'Authorization: Bearer $NP_TOKEN'
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
NameInTypeNotes
idrequiredpathintegerThe record id.
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.
namestring(200)Milestone name.
descriptiontextDescription. Stored as text, no practical length limit.
statusstringStatus. Labels are Teamprojectmilestone_model::$statuses; stored as an int and never exposed or accepted as one (D35). One of pending, inprogress, completed, missed.
duedatestringDate payment is due.
sortorderintegerDisplay order. Lower sorts first.
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/teamprojectmilestones/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "status": "pending"
}'
Response 200
{
    "status": "pending"
}
DELETE/teamprojectmilestones/{id} 200404

Cancel.

Requires scope projects:cancel.

Parameters
NameInTypeNotes
idrequiredpathintegerThe record id.
When it fails
StatusCodeMeaning
404not_foundNo record with that id.
curl -X DELETE \
  'https://acme.nolapro.com/!/api/v2/teamprojectmilestones/104' \
  -H 'Authorization: Bearer $NP_TOKEN'
Response 200
{
    "status": "pending"
}