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"
        }
    }
}
Ця стаття була вам корисною? Так, дякую! Ні
esc
или
Роздрукувати