WORKSECTION

Комментарии

Получение комментариев задачи/подзадачи через API: get_comments

Пример get_comments запроса

https://your-domain.com/api/admin/v2/?action=get_comments&
page=/project/PROJECT_ID/TASK_ID/SUBTASK_ID/&hash=HASH
Обязательные параметры:
Необязательные параметры:
  • extra=files — возвращает информацию о прикрепленных к комментариям файлах
Возвращаемые данные:
  • text — текст комментария
  • date_added — дата и время отправки
  • email — email автора комментария
  • name — имя и фамилия автора комментария
  • files — информация о прикрепленных в комментариях файлах (если в запросе указан соответствующий параметр extra):
    • id — уникальный номер файла (можно использовать в методе download для скачивания по API)
    size — размер файла (в байтах)
    name — название файла с расширением
    page — часть ссылки для скачивания напрямую (для полного пути перед полученным значением укажите адрес вашего аккаунта, например https://your-domain.worksection.com/download/123456)

Пример JSON ответа
При успешном выполнении запроса, ответ будет содержать статус ok и следующие данные:

{
    "status": "ok",
    "data": [
        {
            "text": "USER_COMMENT_TEXT",
            "date_added": "YYYY-MM-DD HH:II",
            "user_from": {
                "email": "USER_EMAIL",
                "name": "USER_NAME"
            },
            "files": [
                {
                    "id": "FILE_ID",
                    "size": "FILE_SIZE",
                    "name": "Example.docx",
                    "page": "/download/FILE_ID"
                }
            ],
        }
    ]
}
Эта статья была вам полезна? Да, спасибо! Нет

Создание комментария в задаче/подзадаче через API: post_comment

Пример post_comment запроса

https://your-domain.com/api/admin/v2/?action=post_comment&
page=/project/PROJECT_ID/TASK_ID/SUBTASK_ID/&email_user_from=USER_EMAIL&
text=TEXT&hash=HASH
В данном запросе можно добавлять файлы (см. Как добавлять файлы)

Обязательные параметры:
  • email_user_from — email автора комментария
  • text — текст комментария 
Необязательные параметры:
  • hidden — список email сотрудников, разделенных запятой, которые будут входить в круг видимости комментария. Для других сотрудников комментарий будет скрыт.
  • mention — список email сотрудников, разделенных запятой, которые будут упомянуты в конце* комментария
    * произвольное место проставления не поддерживается
Пример JSON ответа
При успешном выполнении запроса, ответ будет содержать статус ok и url на созданный комментарий:

{
    "status": "ok",
    "url": "http://your-domain.com/project/PROJECT_ID/TASK_ID/#com1764952"
}
Эта статья была вам полезна? Да, спасибо! Нет
esc
или
Распечатать