api:tools:human-tasks:teamoverview
Table of Contents
API : Tools: Human Task : Team Overview
Introduction
This request will return an overview of tasks, usage, create overview for development team
Request
| URL | https://api.telecomx.dk/tools/humantask/overviewteam | ||
|---|---|---|---|
| Method | GET | ||
| Access level | Admin | ||
Query example
https://api.telecomx.dk/tools/humantask/overviewteam
Response
| Field | Type | Description |
|---|---|---|
| employees | Array | List of employees |
| employees[]._id | Id | Id of employee |
| employees[].name | String | Name of employee |
| employees[].emailAddress | String | Employees email address |
| employees[].count.IN_PROGRESS | Number | How many tasks with status IN_PROGRESS |
| employees[].count.REVIEW | Number | How many tasks with status REVIEW |
| employees[].count.ON_HOLD | Number | How many tasks with status ON_HOLD |
| employees[].count.SELECTED | Number | How many tasks with status SELECTED |
| employees[].tasks | Array | List of tasks |
| employees[].tasks[]._id | String | Id of task |
| employees[].tasks[].title | String | Name of task |
| employees[].tasks[].description | Object | Task description |
| employees[].tasks[].status | String | Task status |
| employees[].tasks[].type | String | Task type |
| employees[].tasks[].assigned | Date | Date when created |
| employees[].tasks[].assignedTo | String | Id og assigned employee |
| employees[].tasks[].priority | Number | Priority of the task |
| employees[].tasks[].estimatedCompletion | Date | Estimated date of completion |
| employees[].tasks[].estimate | Date | Estimate time |
| employees[].tasks[].log[] | Array | List of logs |
| employees[].tasks[].startedWork | Date | Date when work was started |
| employees[].tasks[].loggedTime | Number | Number of hours logged |
| employees[].tasks[].updated | Date | Date when last updated |
| employees[].tasks[].project | String | Name of project |
| stats.IN_PROGRESS | Number | How many tasks with status IN_PROGRESS |
| stats.REVIEW | Number | How many tasks with status REVIEW |
| stats.NEW | Number | How many tasks with status NEW |
| stats.ON_HOLD | Number | How many tasks with status ON_HOLD |
| stats.SELECTED | Number | How many tasks with status SELECTED |
| stats.TOTAL | Number | How many tasks in total |
| unassignedTasks[] | Array | List of unassigned tasks |
| unassignedTasks[]._id | String | Id of task |
| unassignedTasks[].title | String | Name of task |
| unassignedTasks[].description | String | Task description |
| unassignedTasks[].status | String | Task status |
| unassignedTasks[].type | String | Task type |
| unassignedTasks[].assigned | Date | Date when created |
| unassignedTasks[].assignedTo | String | Id og assigend employee |
| unassignedTasks[].priority | Number | Priority of the task |
| unassignedTasks[].estimatedCompletion | Date | Estimated date of completion |
| unassignedTasks[].estimate | Date | Estimate time |
| unassignedTasks[].log[] | Array | List of logs |
| unassignedTasks[].startedWork | Date | Date when work was started |
| unassignedTasks[].loggedTime | Number | Number of hours logged |
| unassignedTasks[].updated | Date | Date when last updated |
| unassignedTasks[].project | String | Name of project |
| completedTasks[] | Array | List of completed tasks |
| completedTasks[]._id | String | Id of task |
| completedTasks[]..title | String | Name of task |
| completedTasks[].description | String | Task description |
| completedTasks[].status | String | Task status |
| completedTasks[].type | String | Task type |
| completedTasks[].assigned | Date | Date when created |
| completedTasks[].assignedTo | String | Id og assigend employee |
| completedTasks[].priority | Number | Priority of the task |
| completedTasks[].estimatedCompletion | Date | Estimated date of completion |
| completedTasks[].estimate | Date | Estimate time |
| completedTasks[].log[] | Array | List of logs |
| completedTasks[].startedWork | Date | Date when work was started |
| completedTasks[].loggedTime | Number | Number of hours logged |
| completedTasks[].updated | Date | Date when last updated |
| completedTasks[].project | String | Name of project |
Each task also holds images, files and templateItems as described on Get human task, every attached image and document with _idUrl, its signed download URL - see Signed file URLs.
Properties with no value may be omitted from the response.
Example
{ "employees": [ { "_id": "1234567890123457890ABCD", "name": "Don Johnson", "emailAddress": "dj@telecomx.dk", "count": { "IN_PROGRESS": 3, "REVIEW": 2, "ON_HOLD": 5, "SELECTED": 3 }, "tasks": [ { "_id": "1234567980123456780AAAA", "title": "Some random task", "description": "Stil a random task but with description", "estimate": "½ dag", "priority": 1, "project": "Diverse", "status": "NEW", "createdBy": "1234567890123457890ABCD", "created": "2021-01-01T00:00:00.000Z", "assigned": "2021-01-01T00:00:00.000Z", "assignedTo": "1234567890123457890ABCD", "estimatedCompletion": null, "startedWork": null, "loggedTime": 23,2, "updated": "2021-01-01T00:00:00.000Z", "log": [ { "date": "2021-01-01T00:00:00.000Z", "description": "just another log", "time": 0 }], "toDo": [ { "check": false, "description": "just another to do list" }] } }], "completedTasks": [ { "_id": "1234567980123456780AAAA", "title": "Some random task", "description": "Stil a random task but with description", "estimate": "½ dag", "priority": 1, "project": "Diverse", "status": "NEW", "createdBy": "1234567890123457890ABCD", "created": "2021-01-01T00:00:00.000Z", "assigned": "2021-01-01T00:00:00.000Z", "assignedTo": "1234567890123457890ABCD", "estimatedCompletion": null, "startedWork": null, "loggedTime": 23, "updated": "2021-01-01T00:00:00.000Z", "log": [ { "date": "2021-01-01T00:00:00.000Z", "description": "just another log", "time": 0 }] }], "stats": { "COMPLETED": 1, "IN_PROGRESS": 1, "REVIEW": 1, "NEW": 1, "ON_HOLD": 1, "SELECTED": 1, "TOTAL": 1 }, "unassignedTasks": [ { "_id": "1234567980123456780AAAA", "title": "Some random task", "description": "Stil a random task but with description", "estimate": "½ dag", "priority": 1, "project": "Diverse", "status": "NEW", "createdBy": "1234567890123457890ABCD", "created": "2021-01-01T00:00:00.000Z", "assigned": "2021-01-01T00:00:00.000Z", "assignedTo": "1234567890123457890ABCD", "estimatedCompletion": null, "startedWork": null, "loggedTime": 23, "updated": "2021-01-01T00:00:00.000Z", "log": [ { "date": "2021-01-01T00:00:00.000Z", "description": "just another log", "time": 0 }] }], }
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/tools/human-tasks/teamoverview.txt · Last modified: by Telecom X AI