WORKSECTION

Комментарии

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

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

https://youraccount.worksection.com/api/admin/v2/?action=get_comments&
id_task=TASK_ID&hash=HASH
Возвращает комментарии выбранного задания

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

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

{
    "status": "ok",
    "data": [
        {
            "id": "COMMENT_ID",
            "page": "/project/PROJECT_ID/TASK_ID/SUBTASK_ID/#comCOMMENT_ID",
            "text": "COMMENT_TEXT",
            "date_added": "YYYY—MM—DD HH:II",
            "user_from": {
                "id": "USER_ID",
                "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://youraccount.worksection.com/api/admin/v2/?action=post_comment&
id_task=TASK_ID&email_user_from=USER_EMAIL&
text=TEXT&hash=HASH
Создает комментарий в указанном задании
*позволяет прикреплять файлы (см. детальнее)

Обязательные параметры:
  • id_task — ID задания
Условные параметры:
*обязателен минимум один: text или todo
  • text — текст комментария
  • todo⦋⦌ — чекбокс (для получения чеклиста используйте следующую логику: todo⦋⦌=текст1&todo⦋⦌=текст2) 
Необязательные параметры:
  • email_user_from — email автора комментария (автоматически указывается при использовании токена доступа)
  • hidden — список email сотрудников (через запятую), которые будут входить в круг видимости комментария. Для других сотрудников комментарий будет скрыт.
  • mention — список email сотрудников (через запятую), которые будут упомянуты в конце комментария
Пример JSON ответа
При успешном выполнении запроса, ответ будет содержать статус ok и следующие данные:

{
    "status": "ok",
    "data": {
        "id": "COMMENT_ID",
        "page": "/project/PROJECT_ID/TASK_ID/SUBTASK_ID/#comCOMMENT_ID",
        "text": "COMMENT_TEXT",
        "date_added": "YYYY—MM—DD HH:II",
        "user_from": {
            "id": "USER_ID",
            "email": "USER_EMAIL",
            "name": "USER_NAME"
        }
    }
}
Эта статья была вам полезна? Да, спасибо! Нет
Вторжение России в Украину Worksection прекратил работу на территории РФ Почему?
esc
или
Распечатать