update_task

The unit/update_task request allows you to edit tasks. To create a new task, use unit/create_task. For information about how tasks work in the monitoring system, see Tasks.

svc=unit/update_task&params={
	"itemId": <long>,
	"taskId": <text>,
	"props": {
		"key1": <long>,
		"key2": <text>,
		.....
	}
}

Request example:

https://hst-api.wialon.com/wialon/ajax.html?
svc=unit/update_task&
params={
  "itemId": 1514,
  "taskId": "6f6aeeebad9ebe64bda86924f8d379d8e6b06bd690c53da4aab526c5e221bdb266b52a50",
  "props": {
    "task_status": 2,
    "task_priority": 3
  }
}&
sid=SESSION_IDENTIFIER

The request must contain the following parameters:

To work with the tasks of a unit, the following access rights to it are required:

The task_comments array must contain all the comments that the task has after the update. Pass the existing comments with their id, and a new comment without it:

[
    { "id": 1, "comment": "Unit delivered to the service station." },
    { "id": 2, "comment": "Oil and filters replaced." },
    { "comment": "Spare parts ordered, waiting for delivery." }
]

If a comment has been previously added to the task, but its id isn’t included in the array, the comment is deleted.

For a new comment, the system assigns the next id (the comments of a task are numbered starting from 1) and sets the author to the current user. You can also pass the timestamp field with the time of the comment as a UNIX timestamp. By default, the system uses the current server time.

For an existing comment, only the text can be changed. If you change it, the system records who edited the comment and when.

For the same actions in the monitoring system, see Comments.

To add a comment, pass an object of the following format in the task_comments array:

{ "comment": "Spare parts ordered, waiting for delivery." }

To edit a comment, specify its ID in the task_comments array and include the new comment text:

{ "id": 2, "comment": "Oil and filters replaced. Next service due at 140000 km." }

To delete a comment, remove it from the task_comments array.

To add or edit additional task parameters, include the task_params object in the props parameter with the desired key-value pairs:

{
    "itemId": 1514,
    "taskId": "6f6aeeebad9ebe64bda86924f8d379d8e6b06bd690c53da4aab526c5e221bdb266b52a50",
    "props": {
        "task_params": {
            "filled": 50.5,
            "mileage": 125.8,
            "cost": 150
        }
    }
}

Specify the filled and mileage values in the unit’s current measurement system (SI, US, imperial, or metric with gallons). The measurement system is set in the mu property of the unit. For details, see General properties. The charged, cost, and engine_hours values are stored as they are passed.

The unit/update_task request updates one task. To update several tasks at once (for example, to assign them to the same user, or to change their status or priority), combine unit/update_task requests in a core/batch request.

Each element of the params array is a separate unit/update_task request with its own itemId and taskId.

svc=core/batch&params={
  "params": [
    {
      "svc": "unit/update_task",
      "params": {
        "itemId": 1514,
        "taskId": "6f6aeeebad9ebe64bda86924f8d379d8e6b06bd690c53da4aab526c5e221bdb266b52a50",
        "props": {
          "task_status": 6,
          "task_comments": [
            { "comment": "Checked by the operator." }
          ]
        }
      }
    },
    {
      "svc": "unit/update_task",
      "params": {
        "itemId": 1515,
        "taskId": "8a21bcb0ad9ebe64bda86924f8d379d8e6b06bd690c53da4aab526c5e221ff416a8d46d0",
        "props": {
          "task_status": 6,
          "task_comments": [
            { "comment": "Checked by the operator." }
          ]
        }
      }
    }
  ],
  "flags": 0
}

Keep in mind the following:

For the description of the flags parameter, see core/batch.

If the request is completed successfully, an empty response is returned.

{}

Otherwise, an error code is returned. Example:

{
    "error": 5,
    "reason": "TASK_NOT_FOUND"
}

For the general error codes, see Error codes.