API : Tools: Human Task : List

Introduction

This request will return a list of human tasks (Dev/Ops task).

Request

URL	https://api.telecomx.dk/tools/humantask
Method	GET
Access level	Admin
Query	offset	Number	`[optional]` Index of first item to return. Default 0.
	limit	Number	`[optional]` Max number of items to return, 1-500. Default 50.
	assignedToNames	Boolean	`[optional]` True to add names to assignedTo.
	createdBy	Id	`[optional]` Id of employee tasks must be created by.
	updatedBy	Id	`[optional]` Id of employee tasks myst be updated by.
	project	String	`[optional]` Name of project tasks must belong to.
	projects	String	`[optional]` List of projects tasks must belong to.
	status	String	`[optional]` Status tasks must have - NEW, LATER, SELECTED, IN_PROGRESS, ON_HOLD, REVIEW, PENDING, COMPLETED, REJECTED, LATER.
	type	String	`[optional]` Type tasks must be - REQUEST, BUG, MAINTENANCE, SUPPORT.
	title	String	`[optional]` Task title filter.
	assignedTo	Id	`[optional]` Id of employee tasks must be assigned to.
	filterBy	String	`[optional]` If CREATED_BY, assignedTo instead filters by who created the task, ASSIGNED_TO filter by who task is assigned to (default).
	priority	Number	`[optional]` Priority of tasks (1-4).
	sort	String	`[optional]` Sort by CREATED, UPDATED, STATUS or TYPE. Defaults to CREATED. A minus in front will reverse the sorting, e.g. -UPDATED = most recently updated first.
	prevnext	Boolean	`[optional]` True to return id of previous and next in relation to current.
	current	Id	`[optional]` Id of current item if prevnext is true.

Query example

https://api.telecomx.dk/tools/humantask?createdBy=12345678901234568790ABCD
https://api.telecomx.dk/tools/humantask?project=PBX&status=IN_PROGRESS&type=BUG
https://api.telecomx.dk/tools/humantask?priority=1&project=PBX
https://api.telecomx.dk/tools/humantask?assignedTo=12345678901234567890BBBB&offset=100&limit=50&sort=CREATED

Response (normal)

Array of tasks, each with the following object.

Field	Type	Description
offset	Number	Index of first item returned.
limit	Number	Number of items returned at most.
total	Number	Total number of items possible.
_id	Id	Unique id of task.
created	Date	Date when task was created.
createdBy	Id	Id of employee who created the task.
updated	Date	Date when task was updated.
updatedBy	Id	Id of employee who last updated the task.
project	String	Name of project task belongs to.
status	String	Status of the task: NEW, LATER, SELECTED, IN_PROGRESS, ON_HOLD, REVIEW, PENDING, COMPLETED, REJECTED.
type	String	Type of task: REQUEST, BUG, MAINTENANCE, SUPPORT.
title	String	Task title - short description of task.
description	String	Long description of task.
assigned	Date	Date when task was assigned.
assignedTo	Id	Id of employee the task is assigned to, if any.
assignedToName	String	Name of employee the task is assigned to, if requested.
priority	Number	Priority of the task.
estimatedCompletion	Date	When the task is estimated to be completed.
startedWork	Date	Date when work on the task started.
endedWork	Date	Date when work on the task ended (status went to COMPLETED or REJECTED).
log	Array	Log of changes to and work done on the task.
log[].date	Date	Date of log event.
log[].description	String	Description of the log event.
log[].time	Number	Number of minutes spent on the task.

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

{
  offset: 0,
  limit: 100,
  total: 200,
  tasks: [
    {
      "_id":"12345678901234567890ABCD",
      "created": "2021-01-01T00:00:00.000Z",
      "createdBy": "12345678901234567890AAAA",
      "updated": "2021-01-01T00:00:00.000Z",
      "updatedBy": "12345678901234567890AAAB",
      "project": "PBX",
      "status": "IN_PROGRESS",
      "type": "BUG",
      "title": "Cannot save queues when no audio selected",
      "description": "Save function is disabled when no audio is selected. Queues does not require audio.",
      "assigned": "2020-01-01T00:00:00.000",
      "assignedTo": "12345678901234567890AAAC",
      "priority": 1,
      "estimatedCompletion": "2021-01-01T00:00:00.000Z",
      "startedWork": "2021-01-01T00:00:00.000Z",
      "endedWork": "2021-01-01T00:00:00.000Z",
      "log": [
        {
           "date": "2021-01-01T00:00:00.000Z",
           "description": "Status changed from NEW to IN_PROGRESS",
           "time": null
        },
        {
          ...
        }
      ]
    }
  ]
}

Response (prevnext=true)

Field	Type	Description
previous	Id	Id of previous task
next	Id	Id of next task
index	Number	index of current task
total	Number	Total number of items possible

Example

{
  previous: '12345678901234567890ABCD',
  next: '1234567890123457890ABCC',
  index: 22,
  total: 203
}

Errors

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

WIKI

Table of Contents

API : Tools: Human Task : List

Introduction

Request

Query example

Response (normal)

Example

Response (prevnext=true)

Example

Errors