Table of Contents

API : Tools: Human Task : Update

Introduction

This request will update a human task (Dev/Ops task).

Request

URL https://api.telecomx.dk/tools/humantask/TASK_ID
Method POST
Access level RESELLER_ADMIN or ADMIN
Param TASK_ID Id Id of task to update.
Body project String Required. Name of project task belongs to.
status String Status of the task: NEW, SELECTED, IN_PROGRESS, ON_HOLD, REVIEW, PENDING, COMPLETED, REJECTED, LATER. Default NEW.
type String Type of task: REQUEST, BUG, MAINTENANCE, SUPPORT. Default REQUEST.
title String Required. Task title - short description of task, 1-256 characters.
description String Long description of task. Default empty.
assignedTo Id Id of employee the task is assigned to, if any.
priority Number Priority of the task, 1-4. Default 4.
estimate String Amount of time task is assumed to take: Ikke specificeret, ½ Dag, 1 Dag, 3 Dage, 1 Uge, 2 Uger, 1 Måned. Default Ikke specificeret.
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.

Send the whole task, as returned by Get. A property left out is set to its default, and the log to an empty array. Arrays must be set in full.

Query example

{
  "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.",
  "assignedTo": "12345678901234567890AAAC",
  "priority": 1,
  "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

Field Type Description
_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, SELECTED, IN_PROGRESS, ON_HOLD, REVIEW, PENDING, COMPLETED, REJECTED, LATER.
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.
priority Number Priority of the task.
estimatedCompletion Date When the task is estimated to be completed.
estimate String Amount of time task is assumed to take: Ikke specificeret, ½ Dag, 1 Dag, 3 Dage, 1 Uge, 2 Uger, 1 Måned
startedWork Date Date when work on the task started.
endedWork Date Date when work on the task ended (status went to COMPLETED or REJECTED).
referenceId Number Reference id
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.
images Array List of images used inline in the description.
images[]._id Id Id of image in image servers.
images[]._idUrl String Signed download URL of the image (JPEG) - see Signed file URLs.
images[].type String Type of image, e.g. png, jpeg, gif.
images[].size Number Size of image in bytes.
files Array List of documents attached to the task.
files[]._id Id Id of document on document servers.
files[]._idUrl String Signed download URL of the document - see Signed file URLs.
files[].filename String Filename.
files[].type String File type.
files[].size Number Size of file in bytes.

Properties with no value may be omitted from the response.

Example

{
  "_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",
  "estimate": "Ikke specificeret",
  "startedWork": "2021-01-01T00:00:00.000Z",
  "endedWork": "2021-01-01T00:00:00.000Z",
  "referenceId": 1,
  "log": [
    {
       "date": "2021-01-01T00:00:00.000Z",
       "description": "Status changed from NEW to IN_PROGRESS",
       "time": null
    }
  ],
  "images": [
    {
      "_id": "12345678901234567890ABCE",
      "type": "png",
      "size": 12345
    }
  ],
  "files": [
    {
      "_id": "12345678901234567890AAAA",
      "filename": "my-document.pdf",
      "type": "pdf",
      "size": 587954
    }
  ]
}

Errors

Error code Message Description
422 <property> Invalid input for the named property - the request body, query or URL parameter failed validation
404 <property> A required property is missing from the request
404 not_found Task not found
404 assignedTo Employee not found
403 access_denied Insufficient access level
500 internal_error <Unspecified>