Table of Contents

API : Tools: Human Task : Overview

Introduction

This request will return an overview of employees with tasks, for use on a wallboard etc.

Request

URL https://api.telecomx.dk/tools/humantask/overview
Method GET
Access level RESELLER_ADMIN, ADMIN

Query example

https://api.telecomx.dk/tools/humantask/overview

Response

Field Type Description
employees Array List of employees
employees[]._id Id Id of employee
employees[].name String Name of employee
employees[].assigned Number Number of tasks assigned to the employee, that are not completed or rejected
employees[].inProgress Array List of tasks the employee is working on
employees[].inProgress[]._id Id Id of task
employees[].inProgress[].title String Name of task
employees[].inProgress[].priority Number Priority of the task
employees[].inProgress[].estimatedCompletion Date Estimated date of completion
employees[].inProgress[].startedWork Date Date when work was started
employees[].inProgress[].loggedTime Number Number of hours logged
employees[].inProgress[].updated Date Date when last updated
employees[].inProgress[].project String Name of project
employees[].selected Array List of tasks the employee is working on
employees[].selected[]._id Id Id of task
employees[].selected[].title String Name of task
employees[].selected[].priority Number Priority of the task
employees[].selected[].estimatedCompletion Date Estimated date of completion
employees[].selected[].startedWork Date Date when work was started
employees[].selected[].loggedTime Number Number of hours logged
employees[].selected[].updated Date Date when last updated
employees[].selected[].project String Name of project
employees[].others Array List of tasks the employee is working on
employees[].others[]._id Id Id of task
employees[].others[].title String Name of task
employees[].others[].priority Number Priority of the task
employees[].others[].estimatedCompletion Date Estimated date of completion
employees[].others[].startedWork Date Date when work was started
employees[].others[].loggedTime Number Number of hours logged
employees[].others[].updated Date Date when last updated
employees[].others[].project String Name of project
highestPriority[] Array List of highest priority tasks
highestPriority[]._id Id Id of task
highestPriority[].title String Name of task
stats Object Statistics
stats.total Number Total number of tasks
stats.assigned Number Number of tasks that has been assigned
projects Array List of projects and their stats
projects[].name String Name of project
projects[].total Number Number of tasks in the project, not completed or rejected
projects[].selected Number Number of tasks selected to be done
projects[].inProgress Number Number of tasks in progress
projects[].requests Number Number of requests
projects[].bugs Number Number of bugs
projects[].maintenance Number Number of maintenance tasks
projects[].minor Number Number of minor tasks
projects[].support Number Number of support tasks
projects[].debug Number Number of debugging tasks

Properties with no value may be omitted from the response.

Example

{
  "employees": [
    {
      "_id": "1234567890123457890ABCD",
      "name": "Don Johnson",
      "assigned": 12,
      "inProgress": [
        {
          "_id": "1234567980123456780AAAA",
          "title": "Some random task",
          "priority": 1,
          "estimatedCompletion": null,
          "startedWork": null,
          "loggedTime": 23,2,
          "updated": "2021-01-01T00:00:00.000Z"
        }
      ],
      "selected": [
        {
          "_id": "1234567980123456780AAAA",
          "title": "Some random task 2",
          "priority": 1,
          "estimatedCompletion": null,
          "startedWork": null,
          "loggedTime": 23,2,
          "updated": "2021-01-01T00:00:00.000Z"
        }
      ],
      "others": [
        {
          "_id": "1234567980123456780AAAA",
          "title": "Some random task 3",
          "priority": 1,
          "estimatedCompletion": null,
          "startedWork": null,
          "loggedTime": 23,2,
          "updated": "2021-01-01T00:00:00.000Z"
        }
      ]
    }
  ],
  "highestPriority": [
    {
      "_id": "12345678901234567890BBBB",
      "title": "Some other random task"
    }
  ],
  "stats": {
    "total": 324,
    "assigned": 23
  },
  "projects": [
    "name": "TCX",
    "total": 200,
    "selected": 10,
    "inProgress": 2,
    "requests": 43,
    "bugs": 64,
    "maintenance": 5,
    "minor": 4,
    "support": 3,
    "debug": 2
  ]
}

Errors

Error code Message Description
403 access_denied Insufficient access level
500 internal_error <Unspecified>