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
или
Роздрукувати