New Task Card: Overview of Changes

The new task card has moved comments to chat. The old task methods continue to function, except for operations involving comments. Changes are available starting from module version tasks 25.700.0.

What Remains UnchangedWhat Remains Unchanged

• The task.* methods for creating and updating tasks, files, and checklists work as before.
• Adding a comment via task.commentitem.add is still functional.

What Has Changed in CommentsWhat Has Changed in Comments

• Updating and deleting comments using the methods task.commentitem.update and task.commentitem.delete no longer work. Use the Chat methods instead:
  • im.message.update to change the text,
  • im.message.delete to delete a message.
• Retrieving the list of comments via task.commentitem.getlist is no longer functional. Get task chat messages through im.dialog.messages.get.
• Use the method im.disk.file.commit to send files in the task chat.
• The chat associated with the task is returned in the response of tasks.task.get. Use its identifier for requests in chat methods.

How to Get the Task Chat ID via tasks.task.getHow to Get the Task Chat ID via tasks.task.get

Old API VersionOld API Version

POST https://{installation_address}/rest/{user_id}/{rest_app_password}/tasks.task.get
        {
            "taskId": 51,
            "select": ["CHAT_ID"]
        }
        

Example response:

{
            "result": {
                "task": {
                    "id": "3835",
                    "chatId": 2537,
                    "favorite": "N",
                    "group": [],
                    "action": {
                        ...
                    }
                }
            }
        }    
        

New API VersionNew API Version

Request the fields chat.id, chat.entityId, chat.entityType for the task:

POST https://{installation_address}/rest/api/{user_id}/{rest_app_password}/tasks.task.get
        {
            "id": 51,
            "select": ["id", "chat.id", "chat.entityId", "chat.entityType"]
        }
        

Example response:

{
            "result": {
                "item": {
                    "id": 51,
                    "chat": {
                        "id": 58,
                        "entityId": 51,
                        "entityType": "TASKS_TASK"
                    }
                }
            }
        }
        

How to Send Messages to a TaskHow to Send Messages to a Task

• Old method task.commentitem.add.
• New method tasks.task.chat.message.send. To send a file in the task chat, use the method im.disk.file.commit.

EventsEvents

• The event OnTaskCommentAdd works. When working with the new task card, the handler will receive parameters:

  • MESSAGE_ID with the identifier of the message in the task chat,
  • TASK_ID with the identifier of the task,
  • 'ID' => 0 the identifier of the comment will equal zero.

• The events OnTaskCommentUpdate and OnTaskCommentDelete do not work in the new task card.

Task ResultTask Result

• The method tasks.task.result.list works. When working with the new task card, all task results will be returned with the parameter commentId: 0.

• The methods tasks.task.result.addFromComment and tasks.task.result.deleteFromComment do not work in the new task card.

WidgetsWidgets

The locations of the widgets TASK_VIEW_SIDEBAR, TASK_VIEW_TOP_PANEL, TASK_VIEW_TAB are no longer relevant in the new task card. In the new card, all widgets are displayed in a single "Applications" block.

All previously registered widgets continue to work. New widgets can also be registered, and they will be displayed in the "Applications" block.