Task Notes
Get All Task Notes
This endpoint returns a list of Task Note resources.
GET /api/v2/projects/{project_id}/tasks/{task_id}/notes/
URL Parameters
| Parameter | Description |
|---|---|
| project_id | The id of the Project |
| task_id | The id of the Task |
GET /api/v2/projects/1/tasks/1-T2/notes/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
HTTP/1.1 200 OK
Content-Type: application/json
{
"results": [{
"id": 682,
"task": "1-T2",
"text": "This task is on-hold until we...",
"automatic": true,
"updater": {
"first_name": "Admin",
"last_name": "Testerton",
"is_active": true,
"email": "admin@example.com",
"role": {
"id": "UR4",
"name": "Administrator"
},
"id": 1
},
"created": "2015-03-26T19:50:46.348000Z",
"updated": "2015-03-26T19:50:46.348000Z"
}]
}
Create a Task Note
POST /api/v2/projects/{project_id}/tasks/{task_id}/notes/
URL Parameters
| Parameter | Description |
|---|---|
| project_id | The id of the Project |
| task_id | The id of the Task |
Payload
| Fields | Required | Description |
|---|---|---|
| text | Yes | The text for the task note. |
POST /api/v2/projects/1/tasks/1-T2/notes/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
{
"text": "Desired text for a note."
}
HTTP/1.1 201 CREATED
Content-Type: application/json
{
"automatic": false,
"text": "Desired text for a note",
"id": 5,
"created": "2019-01-30T14:43:24.115695-05:00",
"updater": {
"first_name": "Admin",
"last_name": "Testerton",
"is_active": true,
"email": "test@example.com",
"role": {
"id": "UR4",
"name": "Administrator"
},
"id": 1
},
"updated": "2019-01-30T14:43:24.115695-05:00",
"task": "T2"
}
Update a Task Note
PATCH /api/v2/projects/{project_id}/tasks/{task_id}/notes/{note_id}/
URL Parameters
| Parameter | Description |
|---|---|
| project_id | The id of the Project |
| task_id | The id of the Task |
| note_id | The id of the Note |
Payload
| Fields | Required | Description |
|---|---|---|
| text | No | The text for the task note. |
PATCH /api/v2/projects/1/tasks/1-T2/notes/5/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
{
"text": "Updated text for a note."
}
HTTP/1.1 201 CREATED
Content-Type: application/json
{
"automatic": false,
"text": "Updated text for a note.",
"id": 5,
"created": "2019-01-30T14:43:24.115695-05:00",
"updater": {
"first_name": "Admin",
"last_name": "Testerton",
"is_active": true,
"email": "test@example.com",
"role": {
"id": "UR4",
"name": "Administrator"
},
"id": 1
},
"updated": "2019-01-30T14:43:24.115695-05:00",
"task": "T2"
}