WORKSECTION

Завдання

Отримання списку всіх задач/підзадач аккаунту через API: get_all_tasks

Приклад get_all_tasks запиту

https://your—domain.com/api/admin/v2/?action=get_all_tasks&hash=HASH 
Повертає дані всіх відкритих і закритих задач/підзадач акаунту
У цьому запиті параметр page не потрібен

Необов'язкові параметри:
  • show_subtasks=1 — повертає поле child (якщо доступно), яке містить список підзадач в аналогічному форматі. Доступно 2 рівня вкладеності: задача / підзадача / під-підзадача
  • extra — повертає додаткові дані по задачах/підзадачах (можна вказувати через кому, наприклад extra=text,files):
  • text або html — опис відповідно у текстовому або html форматі
    files — інформацію по прикріплених до опису файлах
  • filter=active (аналогічно status=active) — повертає дані тільки по відкритих завданнях проекту. Для відображення тільки закритих завдань окреме значення зазначеного параметра не передбачено

Повертаються наступні дані по задачах/підзадачах:
  • id — унікальний номер
  • name — назва задачі/підзадачі
  • page — посилання на задачу/підзадачу (див. формат посилання)
  • status — статус (active/done — відкрита/закрита)
  • priority — пріоритет (діапазон значень: 0..10)
  • user_from і user_to — інформація про автора і відповідального співробітника
  • project — інформація про проект (його id, name і page)
  • text — текст опису задачі/підзадачі в текстовому або html форматі (якщо в запиті вказано відповідний параметр extra)
  • date_added — дата та час створення
  • date_start — дата, коли задача/підзадача повинна стартувати (якщо зазначено)
  • date_end — дата, коли задача/підзадача повинна бути закрита (якщо зазначено)
  • date_closed — дата та час закриття
  • time_end — час виконання задачі/підзадачі (якщо зазначено)
  • max_time і max_money — планові фінансові витрати (якщо вказано)
  • tags — масив у форматі id: name для статусів і міток задачі/підзадачі (якщо вказано)
  • files — інформація по прикріплених до опису файлах (якщо в запиті вказано відповідний параметр extra):
  • id — унікальний номер файлу (можна використовувати в методі download для завантаження з API)
    size — розмір файлу (в байтах)
    name — назва файлу з розширенням
    page — частина посилання для завантаження напряму (для повного шляху перед отриманим значенням вкажіть адресу вашого акаунту, наприклад https://your-domain.worksection.com/download/123456)
  • child — аналогічний масив даних по підзадачам і під-підзадачам, які входять до задачі (якщо в запиті вказано відповідний параметр show_subtasks=1)

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{
    "status": "ok",
    "data": [
        {
            "id": "TASK_ID",
            "name": "TASK_NAME_1",
            "page": "/project/PROJECT_ID/TASK_ID/",
            "status": "done",
            "priority": "0..10",
            "user_from": {
                "id": "USER_ID",
                "email": "USER_EMAIL",
                "name": "USER_NAME"
            },
            "user_to": {
                "id": "USER_ID",
                "email": "USER_EMAIL",
                "name": "USER_NAME"
            },
            "project": {
                "id": "PROJECT_ID",
                "name": "PROJECT_NAME",
                "page": "/project/PROJECT_ID/"
            },
            "text": "TASK_TEXT",
            "date_added": "YYYY—MM—DD HH:II",
            "date_start": "YYYY—MM—DD",
            "date_end": "YYYY—MM—DD",
            "date_closed": "YYYY—MM—DD HH:II",
            "time_end": "HH:II",
            "max_time": "50",
            "max_money": "100",
            "tags": {
                "TAG_ID": "TAG_NAME_1",
                "TAG_ID": "TAG_NAME_2"
            },
            "files": [
                {
                    "id": "FILE_ID",
                    "size": "FILE_SIZE",
                    "name": "Example.docx",
                    "page": "/download/FILE_ID"
                }
            ],
"child": [ { "id": "SUBTASK_ID", "name": "SUBTASK_NAME_1", "page": "/project/PROJECT_ID/TASK_ID/SUBTASK_ID/", ... ... ..., "child": [ { "id": "SUBTASK_ID", "name": "SUBTASK_NAME_2", "page": "/project/PROJECT_ID/TASK_ID/SUBTASK_ID/", ... ... ... } ]
} ] }, { "id": "TASK_ID", "name": "TASK_NAME_2", "page": "/project/PROJECT_ID/TASK_ID/", ... ... ... } ] }

Отримання задачі/підзадачі проекту через API: get_task

Приклад get_task запиту

https://your—domain.com/api/admin/v2/?action=get_task&
page=/project/PROJECT_ID/TASK_ID/SUBTASK_ID/&hash=HASH

Повертає дані обраної відкритої або закритої задачі/підзадачі певного проекту

Обов'язкові параметри:
Необов'язкові параметри:
  • extra — повертає додаткові дані по задачі/підзадачі (можна вказувати через кому, наприклад extra=text,subscribers,files):
text або html — опис у відповідно текстовому або html форматі
subscribers — список підписників
files — інформація по прикріплених до опису файлах

Повертаються наступні дані по задачі/підзадачі:
  • id — її унікальний номер
  • name — назва задачі/підзадачі
  • status — статус (active/done — відкрита/закрита)
  • priority — пріоритет (діапазон значень: 0..10)
  • user_from і user_to — інформація про автора і відповідального співробітника
  • project — інформація про проект (його id, name і page)
  • parent — масив даних по батьківській задачі (якщо в параметрі page вказана сторінка підзадачі)
  • text — текст опису задачі/підзадачі в текстовому або html форматі (якщо в запиті вказано параметр extra)
  • date_added — дата і час створення
  • date_start — дата, коли задача/підзадача повинна стартувати (якщо зазначено)
  • date_end — дата, коли задача/підзадача повинна бути закрита (якщо зазначено)
  • date_closed — дата та час закриття
  • time_end — час виконання задачі/підзадачі (якщо зазначено)
  • max_time і max_money — планові фінансові витрати (якщо вказано)
  • tags — масив у форматі id: name для статусів і міток задачі/підзадачі (якщо вказано)
  • files — інформація по прикріплених до опису файлах (якщо в запиті вказано параметр extra):
  • id — унікальний номер файлу (можна використовувати в методі download для завантаження з API)
    size — розмір файлу (в байтах)
    name — назва файлу з розширенням
    page — частина посилання для завантаження напряму (для повного шляху перед отриманим значенням вкажіть адресу вашого акаунту, наприклад https://your-domain.worksection.com/download/123456)
  • subscribers — список підписників з інформацією по них (якщо в запиті вказано параметр extra)

Приклад JSON відповіді
Показаний для підзадачі/під-підзадачі (для задачі структура відповіді ідентична, тільки без масиву даних parent)

При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{
    "status": "ok",
    "data": {
        "id": "SUBTASK_ID",
        "name": "SUBTASK_NAME",
        "page": "/project/PROJECT_ID/TASK_ID/SUBTASK_ID/",
        "status": "active",
        "priority": "0..10",
        "user_from": {
            "id": "USER_ID",
            "email": "USER_EMAIL",
            "name": "USER_NAME"
        },
        "user_to": {
            "id": "USER_ID",
            "email": "USER_EMAIL",
            "name": "USER_NAME"
        },
        "project": {
            "id": "PROJECT_ID",
            "name": "PROJECT_NAME",
            "page": "/project/PROJECT_ID/"
        },
        "parent": {
            "id": "TASK_ID",
            "name": "TASK_NAME",
            "page": "/project/PROJECT_ID/TASK_ID/",
            "status": "active",
            "priority": "0..10",
}, "text": "SUBTASK_TEXT", "date_added": "YYYY—MM—DD HH:II", "date_start": "YYYY—MM—DD", "date_end": "YYYY—MM—DD", "date_closed": "YYYY—MM—DD HH:II", "time_end": "HH:II", "max_time": "25", "max_money": "50", "tags": { "TAG_ID": "TAG_NAME_1",
"TAG_ID": "TAG_NAME_2"
},  "files": [   { "id": "FILE_ID",   "size": "FILE_SIZE",  "name": "Example.docx",  "page": "/download/FILE_ID"   }  ],   "subscribers": [   {   "id": "USER_ID",  "email": "USER_EMAIL",   "name": "USER_NAME_1"
  },   {   "id": "USER_ID",  "email": "USER_EMAIL",   "name": "USER_NAME_2"   }   ] } }

Отримання списку задач проекту через API: get_tasks

Приклад get_tasks запиту

https://your—domain.com/api/admin/v2/?action=get_tasks&
page=/project/PROJECT_ID/&hash=HASH

Повертає дані всіх відкритих і закритих задач/підзадач певного проекту

Обов'язкові параметри:
Необов'язкові параметри:
  • show_subtasks=1 — повертає поле child (якщо доступно), яке містить список підзадач в аналогічному форматі. Доступно 2 рівня вкладеності: задача / підзадача / під-підзадача
  • extra — повертає додаткові дані по задачах/підзадачах (можна вказувати через кому, наприклад extra=text,files):
  • text або html — опис відповідно у текстовому або html форматі
    files — інформацію по прикріплених до опису файлах
  • filter=active (аналогічно status=active) — повертає дані тільки по відкритих завданнях проекту. Для відображення тільки закритих завдань окреме значення зазначеного параметра не передбачено

  • Повертаються наступні дані по задачах/підзадачах:
    • id — унікальний номер
    • name — назва задачі/підзадачі
    • page — посилання на задачу/підзадачу
    • status — статус (active/done — відкрита/закрита)
    • priority — пріоритет (діапазон значень: 0..10)
    • user_from і user_to — інформація про автора і відповідального співробітника
    • text — текст опису задачі/підзадачі в текстовому або html форматі (якщо в запиті вказано відповідний параметр extra)
    • date_added — дата і час створення
    • date_start — дата, коли задача/підзадача повинна стартувати (якщо зазначено)
    • date_end — дата, коли задача/підзадача повинна бути закрита (якщо зазначено)
    • date_closed — дата та час закриття
    • time_end — час виконання задачі/підзадачі (якщо зазначено)
    • max_time і max_money — планові фінансові витрати (якщо вказано)
    • tags — масив у форматі id: name для статусів і міток задачі/підзадачі (якщо вказано)
    • files — інформація по прикріплених до опису файлах (якщо в запиті вказано відповідний параметр extra):
    • id — унікальний номер файлу (можна використовувати в методі download для завантаження з API)
      size — розмір файлу (в байтах)
      name — назва файлу з розширенням
      page — частина посилання для завантаження напряму (для повного шляху перед отриманим значенням вкажіть адресу вашого акаунту, наприклад https://your-domain.worksection.com/download/123456)
    • child — аналогічний масив даних по підзадачам і під-підзадачам, які входять до задачі (якщо в запиті вказано відповідний параметр show_subtasks=1)

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{
    "status": "ok",
    "data": [
        {
            "id": "TASK_ID",
            "name": "TASK_NAME_1",
            "page": "/project/PROJECT_ID/TASK_ID/",
            "status": "done",
            "priority": "0..10",
            "user_from": {
                "id": "USER_ID",
                "email": "USER_EMAIL",
                "name": "USER_NAME"
            },
            "user_to": {
                "id": "USER_ID",
                "email": "USER_EMAIL",
                "name": "USER_NAME"
            },
            "text": "TASK_TEXT",
            "date_added": "YYYY—MM—DD HH:II",
            "date_start": "YYYY—MM—DD",
            "date_end": "YYYY—MM—DD",
            "date_closed": "YYYY—MM—DD HH:II",
            "time_end": "HH:II",
            "max_time": "50",
            "max_money": "100",
            "tags": {
                "TAG_ID": "TAG_NAME_1",
                "TAG_ID": "TAG_NAME_2"
            },
            "files": [
                {
                    "id": "FILE_ID",
                    "size": "FILE_SIZE",
                    "name": "Example.docx",
                    "page": "/download/FILE_ID"
                }
            ],
"child": [ { "id": "SUBTASK_ID", "name": "SUBTASK_NAME_1", "page": "/project/PROJECT_ID/TASK_ID/SUBTASK_ID/", ... ... ..., "child": [ { "id": "SUBTASK_ID", "name": "SUBTASK_NAME_2", "page": "/project/PROJECT_ID/TASK_ID/SUBTASK_ID/", ... ... ... } ]
} ] }, { "id": "TASK_ID", "name": "TASK_NAME_2", "page": "/project/PROJECT_ID/TASK_ID/", ... ... ... } ] }

Створення задачі через API: post_task

Приклад post_task запиту

https://your—domain.com/api/admin/v2/?action=post_task&
page=/project/PROJECT_ID/&email_user_from=USER_EMAIL&
title=TASK_NAME&hash=HASH

Створює задачу в зазначеному проекті, незалежно від його статусу (активний, сплячий, архівний)


У цьому запиті можна додавати файли в опис задачі (див. Як додавати файли)


Обов'язкові параметри:
  • email_user_from — email автора задачі
  • title — найменування задачі

Необов'язкові параметри:
  • email_user_to — email відповідального співробітника по задачі (ANY для "будь-який співробітник", NOONE або відсутність зазначеного параметра для "Без відповідального")
  • priority — пріоритет (діапазон значень: 0..10)
  • text — опис задачі
  • todo — чек-ліст (наприклад: todo[]=справа1&todo[]=справа2)
  • datestart — дата, коли задача має стартувати у форматі DD.MM.YYYY
  • dateend — дата, коли задача має бути закрита у форматі DD.MM. YYYY
  • subscribe — список email співробітників, розділених комою, які будуть підписані на завдання
  • hidden — список email співробітників, розділених комою, які будуть входити в коло видимості задачі. Для інших співробітників задача буде прихованою
  • max_time — планові витрати часу
  • max_money — планові фінансові витрати
  • tags — додає статуси/мітки (наприклад: tags=TAG1,TAG2). Можна вказувати найменування (якщо вони унікальні) або їх ID (можна отримати через метод get_tags)

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{
    "status": "ok",
    "data": {
        "id": "TASK_ID",
        "name": "TASK_NAME",
        "page": "/project/PROJECT_ID/TASK_ID/",
        "status": "active",
        "priority": "0..10",
        "user_from": {
"id": "USER_ID",
            "email": "USER_EMAIL",
            "name": "USER_NAME"
        },
        "user_to": { "id": "USER_ID",
            "email": "USER_EMAIL",
            "name": "USER_NAME"
        },
        "project": {
            "id": "PROJECT_ID",
            "name": "PROJECT_NAME",
            "page": "/project/PROJECT_ID/"
        },
        "text": "TASK_TEXT",
        "date_added": "YYYY—MM—DD HH:II",
        "date_start": "YYYY—MM—DD",
        "date_end": "YYYY—MM—DD",
        "max_time": 40,
        "max_money": 200, "tags": { "TAG_ID": "TAG_NAME_1", "TAG_ID": "TAG_NAME_2",
}
    }
}

Створення підзадачі через API: post_subtask

Приклад post_subtask запиту

https://your—domain.com/api/admin/v2/?action=post_subtask&
page=/project/PROJECT_ID/TASK_ID/&email_user_from=USER_EMAIL&
title=TASK_NAME&hash=HASH

Створює підзадачу в певній задачі
Батьківська задача не повинна бути закритою


У цьому запиті можна додавати файли в опис підзадачі (див. Як додавати файли)


Обов'язкові параметри:
  • email_user_from — email автора підзадачі
  • title — назва підзадачі

Необов'язкові параметри:
  • email_user_to — email відповідального співробітника по підзадачі (ANY для "будь-який співробітник", NOONE або відсутність зазначеного параметра для "Без відповідального")
  • priority — пріоритет (діапазон значень: 0..10)
  • text — опис підзадачі
  • todo — чек-ліст (наприклад: todo[]=справа1&todo[]=справа2)
  • datestart — дата, коли підзадача має стартувати у форматі DD.MM.YYYY
  • dateend — дата, коли підзадача має бути закрита у форматі DD.MM. YYYY
  • subscribe — список email співробітників, розділених комою, які будуть підписані на підзадачу
  • hidden — список email співробітників, розділених комою, які будуть входити в коло видимості підзадачі. Для інших співробітників підзадача буде прихованою
  • max_time — планові витрати часу
  • max_money — планові фінансові витрати
  • tags — додає статуси/мітки (наприклад: tags=TAG1,TAG2). Можна вказувати найменування (якщо вони унікальні) або їх ID (можна отримати через метод get_tags)

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{
    "status": "ok",
    "data": {
        "id": "SUBTASK_ID",
        "name": "SUBTASK_NAME",
        "page": "/project/PROJECT_ID/TASK_ID/SUBTASK_ID/",
        "status": "active",
        "priority": "0..10",
        "user_from": { "id": "USER_ID",
            "email": "USER_EMAIL",
            "name": "USER_NAME"
        },
        "user_to": { "id": "USER_ID",
            "email": "USER_EMAIL",
            "name": "USER_NAME"
        },
        "project": {
            "id": "PROJECT_ID",
            "name": "PROJECT_NAME",
            "page": "/project/PROJECT_ID/"
        },
        "parent": {
            "id": "TASK_ID",
            "name": "TASK_NAME",
            "page": "/project/PROJECT_ID/TASK_ID/",
            "status": "active",
            "priority": "0..10"
        },
        "text": "SUBTASK_TEXT",
        "date_added": "YYYY-MM-DD HH:II",
        "date_start": "YYYY-MM-DD",
        "date_end": "YYYY-MM-DD", "max_time": 40, "max_money": 200, "tags": {   "TAG_ID": "TAG_NAME_1",
  "TAG_ID": "TAG_NAME_2"
}
    }
}

Закриття задачі через API: complete_task

Приклад complete_task запиту

https://your—domain.com/api/admin/v2/?action=complete_task&
page=/project/PROJECT_ID/TASK_ID/&hash=HASH

Закриває зазначену задачу
Видасть відповідну помилку, якщо задача вже закрита або містить відкриті підзадачі

Обов'язкові параметри:

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok

{
    "status": "ok"
}

Закриття підзадачі через API: complete_subtask

Приклад complete_subtask запиту

https://your—domain.com/api/admin/v2/?action=complete_subtask&
page=/project/PROJECT_ID/TASK_ID/SUBTASK_ID/&hash=HASH 

Закриває зазначену підзадачу/під-підзадачу
Задача не повинна бути вже закритою і в разі підзадачі не повинна містити відкриті під-підзадачі

Обов'язкові параметри:

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok

{
    "status": "ok"
}

Повторне відкриття задачі через API: reopen_task

Приклад reopen_task запиту

https://your—domain.com/api/admin/v2/?action=reopen_task&
page=/project/PROJECT_ID/TASK_ID/&hash=HASH 

Повторно відкриває вказану задачу

Обов'язкові параметри:

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok

{
    "status": "ok"
}

Повторне відкриття підзадачі через API: reopen_subtask

Приклад reopen_subtask запиту

https://your—domain.com/api/admin/v2/?action=reopen_subtask&
page=/project/PROJECT_ID/TASK_ID/SUBTASK_ID/&hash=HASH 

Повторно відкриває вказану підзадачу або під-підзадачу

Обов'язкові параметри:

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok

{
    "status": "ok"
}

Редагування задачі через API: update_task

Приклад update_task запиту

https://your—domain.com/api/admin/v2/?action=update_task&
page=/project/PROJECT_ID/TASK_ID/&email_user_to=USER_EMAIL&
hash=HASH

Редагує ряд параметрів зазначеної відкритої або закритої задачі
Серед необов'язкових параметрів вказані всі доступні до редагування

Обов'язкові параметри:

Необов'язкові параметри:
  • email_user_to — email відповідального співробітника по задачі (ANY для "будь-який співробітник", NOONE для "Без відповідального")
  • priority — пріоритет (діапазон значень: 0..10)
  • title — назва задачі
  • datestart — дата, коли задача повинна стартувати у форматі DD.MM.YYYY
  • dateend — дата, коли задача має бути закрита у форматі DD.MM.YYYY
  • dateclosed — дата закриття задачі у форматі DD.MM.YYYY
  • max_time — планові витрати часу
  • max_money — планові витрати грошей

Недоступні для редагування (зміни/зняття/додавання) через зазначений метод параметри:
  • email_user_from — email автора задачі
  • text — опис задачі
  • todo — чек-лист
  • subscribe — список email співробітників, розділених комою, які будуть підписані на завдання
  • hidden — список email співробітників, розділених комою, які будуть входити в коло видимості задачі
  • tags — статуси/мітки (можна оновити через окремий метод update_tags)

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{
    "status": "ok",
    "data": {
        "id": "TASK_ID",
        "name": "TASK_NAME",
        "page": "/project/PROJECT_ID/TASK_ID/",
        "status": "active",
        "priority": "0..10",
        "user_from": { "id": "USER_ID",
            "email": "USER_EMAIL",
            "name": "USER_NAME"
      },
        "user_to": { "id": "USER_ID",
            "email": "USER_EMAIL",
            "name": "USER_NAME"
        },
        "project": {
            "id": "PROJECT_ID",
            "name": "PROJECT_NAME",
            "page": "/project/PROJECT_ID/"
        },
        "date_added": "YYYY—MM—DD HH:II",
        "date_start": "YYYY—MM—DD",
        "date_end": "YYYY—MM—DD", "max_time": 40, "max_money": 200, "tags": {   "TAG_ID": "TAG_NAME_1",
  "TAG_ID": "TAG_NAME_2"
}
    }
}

Редагування підзадачі через API: update_subtask

Приклад update_subtask запиту

https://your—domain.com/api/admin/v2/?action=update_subtask&
page=/project/PROJECT_ID/TASK_ID/SUBTASK_ID/&email_user_to=USER_EMAIL&
hash=HASH

Редагує ряд параметрів зазначеної відкритої або закритої підзадачі/під-підзадачі
Серед необов'язкових параметрів вказані всі доступні до редагування

Обов'язкові параметри:

Необов'язкові параметри:
  • email_user_to — email відповідального співробітника по підзадачі (ANY для "будь-який співробітник", NOONE для "Без відповідального")
  • priority — пріоритет (діапазон значень: 0..10)
  • title — найменування підзадачі
  • datestart — дата, коли підзадача повинна стартувати у форматі DD.MM.YYYY
  • dateend — дата, коли підзадача повинна бути закрита у форматі DD.MM. YYYY
  • dateclosed — дата закриття підзадач у форматі DD.MM.YYYY
  • max_time — планові затрати часу
  • max_money — планові витрати грошей

Недоступні до редагування (зміни/зняття/додаванню) через зазначений метод параметри:
  • email_user_from — email автора підзадачі
  • text — опис підзадачі
  • todo — чек-ліст
  • subscribe — список email співробітників, розділених комою, які будуть підписані на підзадачу
  • hidden — список email співробітників, розділених комою, які будуть входити в коло видимості підзадачі
  • tags — статуси/мітки (можна оновити через окремий метод update_tags)

Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{
    "status": "ok",
    "data": {
        "id": "SUBTASK_ID",
        "name": "SUBTASK_NAME",
        "page": "/project/PROJECT_ID/TASK_ID/SUBTASK_ID/",
        "status": "active",
        "priority": "0..10",
        "user_from": { "id": "USER_ID",
            "email": "USER_EMAIL",
            "name": "USER_NAME"
        },
        "user_to": { "id": "USER_ID",
            "email": "USER_EMAIL",
            "name": "USER_NAME"
        },
        "project": {
            "id": "PROJECT_ID",
            "name": "PROJECT_NAME",
            "page": "/project/PROJECT_ID/"
        },
        "parent": {
            "id": "TASK_ID",
            "name": "TASK_NAME",
            "page": "/project/PROJECT_ID/TASK_ID/",
            "status": "active",
            "priority": "0..10"
        },
        "date_added": "YYYY—MM—DD HH:II",
        "date_start": "YYYY—MM—DD",
        "date_end": "YYYY—MM—DD", "max_time": 40, "max_money": 200, "tags": {   "TAG_ID": "TAG_NAME_1",
  "TAG_ID": "TAG_NAME_2"
    }
}

Пошук задач через API: search_tasks

Приклад search_tasks запиту

https://your—domain.com/api/admin/v2/?action=search_tasks&
page=/project/PROJECT_ID/&filter=(name has 'Report' or name has 'Approval')
and (dateend>'25.05.2021' and dateend<'31.05.2021')&hash=HASH
Проводить пошук завдань по одному або ряду параметрів
При відсутності параметра page дані архівних проектів будуть виключені з результатів пошуку

Як мінімум один з наступних параметрів обов'язковий:
  • page — посилання на проект або батьківську задачу (див. формат посилання)
  • email_user_from — email автора завдання
  • email_user_to — email відповідального співробітника
  • filter — пошуковий запит (див. опис нижче)
Необов'язкові параметри:
  • status — статус (active/done — відкрита/закрита)

Цілочисельні поля (Integer):
  • id=TASK_ID — повертає дані певної задачі/підзадачі по її ID (можна отримати через методи get_all_tasks або get_tasks)
  • project=PROJECT_ID — повертає дані по задачах певного проекту по його ID (можна отримати через метод get_projects)
  • parent=TASK_ID — повертає дані по підзадачах певної батьківської задачі по її ID (можна отримати через методи get_all_tasks або get_tasks)
Оператори рівності та діапазону для вказаного типу: =, in
project{=}2456
id {in} (1234, 1240)

Строкові поля (String):
  • name — назва задачі
Повна або часткова відповідність для зазначеного типу: =, has
name{=}'Task Report'
name {has} 'Report'

Поля дат:
  • dateadd або date_added — дата створення завдання у форматі 'DD.MM.YYYY'
  • datestart або date_start — дата, коли завдання має стартувати у форматі 'DD.MM.YYYY'
  • dateend або date_end — дата, коли завдання має бути закрито у форматі 'DD.MM.YYYY'
  • dateclose або date_closed — дата закриття завдання у форматі 'DD.MM.YYYY'
Реляційні оператори для полів дат: >, <, >=, <=, !=, =
date_add{=}'01.05.2021'


Умови запиту можна об'єднувати дужками ( ) і логічними операціями and, or (тільки в нижньому регістрі)

Приклад filterзапиту
&filter=(name has 'Report' or name has 'Approval') and (dateend>'25.05.2021' and dateend<'31.05.2021')

Отримання історії подій за період часу через API: get_events

Приклад get_events запиту

https://your—domain.com/api/admin/v2/?action=get_events&
period=3d&hash=HASH
Повертає дані по подіях у проектах за вказаний період часу (з датою змін, ким змінено, і версії до і після змін)
При відсутності параметра page будуть отримані дані по всіх проектах акаунту

Обов'язкові параметри:
  • period — період часу (можливі діапазони: у хвилинах 1m..360m, в годинах 1h..72h, в днях 1d..30d)

Необов'язкові параметри:

Повертаються наступні дані:
  • action — виконана дія:
  • post — створення нового проекту/завдання/коментаря
    update — оновлення/зміна параметрів поточного проекту/завдання/коментаря
      close — закриття завдання
      reopen — перевідкриття завдання
      delete — видалення коментаря
  • object — інформація по об'єкту, над яким зроблені зазначені в action дії:
  • type — тип об'єкта: проект project, задача/підзадача task і коментар comment
    id — унікальний номер проекту/завдання/коментаря
      page — посилання на проект/завдання (для type = comment також вказана сторінка завдання)
  • date_added — дата і час виконання дії
  • user_from — інформація про те, хто виконав дію (id, email, name)
  • new — поточні або оновлені значення параметрів
  • для action = post це назви зазначених при створенні параметрів нового об'єкта та їх значення
    для action = update це назва параметрів, які змінювалися, і їх нові значення
    • old — назва параметрів, які змінювалися, і їх попередні значення (тільки для action = update)

Приклад JSON відповіді
Показаний для двох виконаних дій: редагування коментаря і зміна терміну завершення завдання

При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{
    "status": "ok",
    "data": [
        {
            "action": "update",
            "object": {
                "type": "comment",
                "id": "COMMENT_ID",
                "page": "/project/PROJECT_ID/TASK_ID/"
            },
            "date_added": "YYYY—MM—DD HH:II",
            "user_from": { "id": "USER_ID",
                "email": "USER_EMAIL",
                "name": "USER_NAME"
            },
            "new": {
                "text": "TEXT"
            },
            "old": {
                "text": "TEXT"
            }
        },
        {
            "action": "update",
            "object": {
                "type": "task",
                "id": "TASK_ID",
                "page": "/project/PROJECT_ID/TASK_ID/"
            },
            "date_added": "YYYY—MM—DD HH:II",
            "user_from": { "id": "USER_ID",
                "email": "USER_EMAIL",
                "name": "USER_NAME"
            },
            "new": {
                "date_end": "YYYY—MM—DD"
            },
            "old": {
                "date_end": "YYYY—MM—DD"
            }
        }
    ]
}
esc
или
Роздрукувати