WORKSECTION

Проєкти

Отримання списку проєктів через API: get_projects

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

https://youraccount.worksection.com/api/admin/v2/?action=get_projects&hash=HASH
Повертає дані по всіх проєктах

Необов'язкові параметри:
  • filter — стан проєкту, можливі значення: active, pending, archived
  • extra — додаткові дані по проєкту, можливі значення (можна вказувати через кому, наприклад extra=text,options,users):
    • text або html — опис у текстовому або html форматі
    options — обмеження проєкту
    users — учасники команди проєкту
Повертаються наступні дані:
  • id — ID проєкту
  • name — назва проєкту
  • status — стан проєкту
  • company — назва папки, в якій розміщено проєкт
  • user_from і user_to — автор проєкту та керівник проєкту
  • text — опис проєкту в текстовому або html форматі (якщо в запиті вказано відповідний параметр extra)
  • date_added — дата і час створення
  • date_closed — дата і час закриття (якщо проєкт переміщено до архіву) або дата і час попереднього закриття (якщо проєкт активний)
  • date_start — дата початку проєкту (якщо зазначено)
  • date_end — дата завершення проєкту (якщо зазначено)
  • options — обмеження проєкту зі значеннями 0/ 1 — вимкнуто/увімкнуто (повертаються, якщо в запиті вказано відповідний параметр extra): 
    • Виконавець може:
  • options.allow_close — закривати завдання
  • options.allow_give — передавати відповідальність 
  • options.allow_term — змінювати терміни задачі
  • options.allow_limit — змінювати заплановані витрати
    • При постановці задачі вимагати PRO:
  • options.require_term — терміни
  • options.require_tag — статуси і мітки
  • options.require_limit — заплановані витрати
  • options.require_hidden — видимість
    • Користувачам заборонено PRO:
  • options.deny_comments_edit — редагувати і видаляти коментарі
  • options.deny_task_edit — редагувати і видаляти завдання
  • options.deny_task_delete — видаляти завдання
    • Внесення витрат PRO:
  • options.time_require — не закривати завдання без витрат
  • options.time_today — тільки за поточний день
  • options.timer_only — тільки з таймера
  • max_time і max_money — планові часові та фінансові витрати (якщо вказано)
  • tags — масив у форматі id: name для тегів проєкту (якщо вказано)
  • users — учасники команди проєкту (якщо в запиті вказано відповідний параметр extra)

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

{
    "status": "ok",
    "data": [ 
        {
            "id": "PROJECT_ID_1",
            "name": "PROJECT_NAME",
            "page": "/project/PROJECT_ID/",
            "status": "active",
            "company": "FOLDER_NAME",
            "user_from": {
                "id": "USER_ID",
                "email": "USER_EMAIL",
                "name": "USER_NAME"
            },
            "user_to": {
                "id": "USER_ID",

                "email": "USER_EMAIL",
                "name": "USER_NAME"
            },
            "text": "PROJECT_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",
            "options": {
               "allow_close": 0..1,
               "allow_give": 0..1,
               "allow_term": 0..1,
               "allow_limit": 0..1,
               "require_term": 0..1,
               "require_tag": 0..1,
               "require_limit": 0..1,
               "require_hidden": 0..1,
               "deny_comments_edit": 0..1,
               "deny_task_edit": 0..1,
               "deny_task_delete": 0..1,
               "time_require": 0..1,
               "time_today": 0..1,
               "timer_only": 0..1
            },
            "max_time": 100,
            "max_money": 500,
            "users": [
                {
                    "id": "USER_ID",
                    "email": "USER_EMAIL",
                    "name": "USER_NAME"
                },
                {
                    "id": "USER_ID",
                    "email": "USER_EMAIL",
                    "name": "USER_NAME"
                },
                {
                    "id": "USER_ID",

                    "email": "USER_EMAIL",
                    "name": "USER_NAME"
                },
                {
                    "id": "USER_ID",

                    "email": "USER_EMAIL",
                    "name": "USER_NAME"
                }
            ]
        },
        {
            "id": "PROJECT_ID_2",
            "name": "PROJECT_NAME",
            ... ... ...
        }
    ]
}
Ця стаття була вам корисною? Так, дякую! Ні

Створення проєкту через API: post_project

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

https://youraccount.worksection.com/api/admin/v2/?action=post_project&
title=PROJECT_NAME&hash=HASH
Створює проєкт
*дозволяє додавати файли (див. детальніше)

Обов'язкові параметри:
  • title — назва проєкту

Необов'язкові параметри:
  • email_user_from — email автора проєкту
  • email_manager — email керівника проєкту
  • email_user_to — email відповідального по умовчанням при створенні завдань, додаткові можливі значення: ANY – «Будь-який співробітник», NOONE або відсутність значення – «Без відповідального»
  • members — email учасників проєкту (через кому)
  • text — опис проєкту
  • company — назва папки, в якій буде розміщено проєкт
  • datestart — дата старта проєкту у форматі DD.MM.YYYY
  • dateend — дата завершення проєкту у форматі DD.MM.YYYY
  • обмеження проєкту (значення рівне 1 для увімкнення): 
    • Виконавець може:
  • options.allow_close — закривати завдання
  • options.allow_give — передавати відповідальність 
  • options.allow_term — змінювати терміни задачі
  • options.allow_limit — змінювати заплановані витрати
    • При постановці задачі вимагати PRO:
  • options.require_term — терміни
  • options.require_tag — статуси і мітки
  • options.require_limit — заплановані витрати
  • options.require_hidden — видимість
    • Користувачам заборонено PRO:
  • options.deny_comments_edit — редагувати і видаляти коментарі
  • options.deny_task_edit — редагувати і видаляти завдання
  • options.deny_task_delete — видаляти завдання
    • Внесення витрат PRO:
    *у цьому блоці одночасно можна увімкнути тільки один параметр
  • options.time_require — не закривати завдання без витрат
  • options.time_today — тільки за поточний день
  • options.timer_only — тільки з таймера
  • extra=options — повертає список обмежень проєкту
  • max_time — планові витрати часу
  • max_money — планові фінансові витрати
  • tags — теги проєкту через кому (наприклад: tags=TAG1,TAG2)
    Можна вказувати назви тегів (якщо вони унікальні) або їх ID (можна отримати через метод get_project_tags)
Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{
    "status": "ok",
    "data": {
        "id": "PROJECT_ID",
        "name": "PROJECT_NAME",
        "page": "/project/PROJECT_ID/",
        "status": "active",
        "company": "FOLDER_NAME",
        "user_from": {
            "id": "USER_ID",
            "email": "USER_EMAIL",
            "name": "USER_NAME"
        },
        "user_to": {
            "id": "USER_ID",

            "email": "USER_EMAIL",
            "name": "USER_NAME"
        },
        "text": "PROJECT_TEXT",
        "date_added": "YYYY-MM-DD HH:II",
        "date_start": "YYYY-MM-DD",
        "date_end": "YYYY-MM-DD",
        "options": {
            "allow_close": 0..1,
            "allow_give": 0..1,
            "allow_term": 0..1,
            "allow_limit": 0..1,
            "require_term": 0..1,
            "require_tag": 0..1,
            "require_limit": 0..1,
            "require_hidden": 0..1,
            "deny_comments_edit": 0..1,
            "deny_task_edit": 0..1,
            "deny_task_delete": 0..1,
            "time_require": 0..1,
            "time_today": 0..1,
            "timer_only": 0..1
        },
        "max_time": 100,
        "max_money": 500,
        "tags": {
            "TAG_ID": "TAG_NAME_1",
            "TAG_ID": "TAG_NAME_2"
        }
    }
}
Ця стаття була вам корисною? Так, дякую! Ні

Архівування проєкту через API: close_project

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

https://youraccount.worksection.com/api/admin/v2/?action=close_project&
id_project=PROJECT_ID&hash=HASH

Архівує вказаний проєкт


Обов'язкові параметри:
  • id_project — ID проєкту
Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok 

{
    "status": "ok"
}
Ця стаття була вам корисною? Так, дякую! Ні

Активування проєкту через API: activate_project

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

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

Активує вказаний архівний проєкт


Обов'язкові параметри:
  • id_project — ID проєкту
Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok 

{
    "status": "ok"
}
Ця стаття була вам корисною? Так, дякую! Ні

Редагування проєкту через API: update_project

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

https://youraccount.worksection.com/api/admin/v2/?action=update_project&
id_project=PROJECT_ID&hash=HASH
Редагує параметри зазначеного проєкту

Обов'язкові параметри:
  • id_project — ID проєкту

Необов'язкові параметри:
  • email_manager — email керівника проєкту
  • email_user_to — email відповідального по умовчанням при створенні завдань, додаткові можливі значення: ANY – «Будь-який співробітник», NOONE або відсутність значення – «Без відповідального»
  • members — email учасників проєкту (через кому), яких треба додати (для виключення використовуйте метод delete_project_members)
  • title — назва проєкту
  • datestart — дата старту проєкту у форматі DD.MM.YYYY
  • dateend — дата завершення проєкту у форматі DD.MM.YYYY
  • обмеження проєкту (возможные значения 0/ 1 — вимкнути/увімкнути): 
    • Виконавець може:
  • options.allow_close — закривати завдання
  • options.allow_give — передавати відповідальність 
  • options.allow_term — змінювати терміни задачі
  • options.allow_limit — змінювати заплановані витрати
    • При постановці задачі вимагати PRO:
  • options.require_term — терміни
  • options.require_tag — статуси і мітки
  • options.require_limit — заплановані витрати
  • options.require_hidden — видимість
    • Користувачам заборонено PRO:
  • options.deny_comments_edit — редагувати і видаляти коментарі
  • options.deny_task_edit — редагувати і видаляти завдання
  • options.deny_task_delete — видаляти завдання
    • Внесення витрат PRO:
    *у цьому блоці одночасно можна увімкнути тільки один параметр
  • options.time_require — не закривати завдання без витрат
  • options.time_today — тільки за поточний день
  • options.timer_only — тільки з таймера
  • extra=options — повертає список обмежень проєкту
  • max_time — планові витрати часу
  • max_money — планові витрати грошей

Недоступні до редагування параметри:
  • email_user_from — email автора проєкту
  • text — опис проєкту
  • company — папка, в якій розміщений проєкт
  • tags — теги проєкту (можна оновити через окремий метод update_project_tags)
Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok і наступні дані:

{
    "status": "ok",
    "data": {
        "id": "PROJECT_ID",
        "name": "PROJECT_NAME",
        "page": "/project/PROJECT_ID/",
        "status": "active",
        "company": "FOLDER_NAME",
        "user_from": {
            "id": "USER_ID",
            "email": "USER_EMAIL",
            "name": "USER_NAME"
        },
        "user_to": {
            "id": "USER_ID",

            "email": "USER_EMAIL",
            "name": "USER_NAME"
        },
        "text": "PROJECT_TEXT",
        "date_added": "YYYY-MM-DD HH:II",
        "date_start": "YYYY-MM-DD",
        "date_end": "YYYY-MM-DD",
        "date_end": "YYYY-MM-DD",
        "options": {
            "allow_close": 0..1,
            "allow_give": 0..1,
            "allow_term": 0..1,
            "allow_limit": 0..1,
            "require_term": 0..1,
            "require_tag": 0..1,
            "require_limit": 0..1,
            "require_hidden": 0..1,
            "deny_comments_edit": 0..1,
            "deny_task_edit": 0..1,
            "deny_task_delete": 0..1,
            "time_require": 0..1,
            "time_today": 0..1,
            "timer_only": 0..1
        },
        "max_time": 100,
        "max_money": 500,
        "tags": {
            "TAG_ID": "TAG_NAME_1",
            "TAG_ID": "TAG_NAME_2"
        }
    }
}
Ця стаття була вам корисною? Так, дякую! Ні

Отримання списку папок проєктів через API: get_project_groups

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

https://youraccount.worksection.com/api/admin/v2/?action=get_project_groups&
hash=HASH
Повертає дані по всіх папках проєктів
Повертаються наступні дані:
  • id — ID папки
  • title — назва папки
  • type — тип папки:
folder — папка, створена учасником акаунту
company — папка команди (створена автоматично після створення команди)
  • client — тип папки company:
0 — папка внутрішньої команди компанії
1 — папка клієнтської команди

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

{
    "status": "ok",
    "data": [
        {
            "id": "GROUP_ID",
            "title": "GROUP_NAME_1",
            "type": "folder"
        },
        {
            "id": "GROUP_ID",
            "title": "GROUP_NAME_2",
            "type": "company",
            "client": 0
        },
        {
            "id": "GROUP_ID",
            "title": "GROUP_NAME_3",
            "type": "company",
            "client": 1
        }
    ]
}
Ця стаття була вам корисною? Так, дякую! Ні

Створення папки для проєктів через API: add_project_group

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

https://youraccount.worksection.com/api/admin/v2/?action=add_project_group&
title=PROJECT_GROUP&hash=HASH
Створює папку для проєктів
*при відсутності папки з аналогічною назвою

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

{
    "status": "ok",
    "data": {
        "id": "GROUP_ID",
        "title": "GROUP_NAME",
        "type": "folder"
    }
}
Ця стаття була вам корисною? Так, дякую! Ні

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

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

https://youraccount.worksection.com/api/admin/v2/?action=get_events&
period=3d&hash=HASH
Повертає дані по виконаних діях у всіх або вказаному проєкті протягом зазначеного періоду часу
*що, коли та ким змінено

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

Необов'язкові параметри:
  • id_project — ID проєкту (дані тільки по зазначеному проєкту)
Повертаються наступні дані:
  • action — виконана дія:
    • post — створення нового проєкту/завдання/коментаря
    update — редагування параметрів проєкту/завдання/коментаря
      close — закриття завдання
      reopen — перевідкриття завдання
      delete — видалення коментаря
  • object — об'єкт, над яким зроблені зазначені в action дії:
    • type — тип об'єкту: project, task і comment
    id — ID об'єкту
      page — посилання на об'єкт
  • date_added — дата і час виконання дії
  • user_from — користувач, який виконав дію
  • 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"
            }
        }
    ]
}
Ця стаття була вам корисною? Так, дякую! Ні

Отримання інформації по проєкту через API: get_project

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

https://youraccount.worksection.com/api/admin/v2/?action=get_project&
id_project=PROJECT_ID&hash=HASH
Повертає дані вибраного проєкту

Обов'язкові параметри:
  • id_project — ID проєкту
Необов'язкові параметри:
  • extra — додаткові дані по проєкту, можливі значення (можна вказувати через кому, наприклад extra=text,options,users):
    • text або html — опис у текстовому або html форматі
    options — обмеження проєкту
    users — учасники команди проєкту
Повертаються наступні дані:
  • id — ID проєкту
  • name — назва проєкту
  • status — стан проєкту
  • company — назва папки, в якій розміщено проєкт
  • user_from і user_to — автор проєкту та керівник проєкту
  • text — опис проєкту в текстовому або html форматі (якщо в запиті вказано відповідний параметр extra)
  • date_added — дата і час створення
  • date_closed — дата і час закриття (якщо проєкт переміщено до архіву) або дата і час попереднього закриття (якщо проєкт активний)
  • date_start — дата початку проєкту (якщо зазначено)
  • date_end — дата завершення проєкту (якщо зазначено)
  • options — обмеження проєкту зі значеннями 0/ 1 — вимкнуто/увімкнуто (повертаються, якщо в запиті вказано відповідний параметр extra):
    • Виконавець може:
  • options.allow_close — закривати завдання
  • options.allow_give — передавати відповідальність 
  • options.allow_term — змінювати терміни задачі
  • options.allow_limit — змінювати заплановані витрати
    • При постановці задачі вимагати PRO:
  • options.require_term — терміни
  • options.require_tag — статуси і мітки
  • options.require_limit — заплановані витрати
  • options.require_hidden — видимість
    • Користувачам заборонено PRO:
  • options.deny_comments_edit — редагувати і видаляти коментарі
  • options.deny_task_edit — редагувати і видаляти завдання
  • options.deny_task_delete — видаляти завдання
    • Внесення витрат PRO:
  • options.time_require — не закривати завдання без витрат
  • options.time_today — тільки за поточний день
  • options.timer_only — тільки з таймера
  • max_time і max_money — планові часові та фінансові витрати (якщо вказано)
  • tags — масив у форматі id: name для тегів проєкту (якщо вказано)
  • users — учасники команди проєкту (якщо в запиті вказано відповідний параметр extra)

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

{
    "status": "ok",
    "data": {
        "id": "PROJECT_ID",
        "name": "PROJECT_NAME",
        "page": "/project/PROJECT_ID/",
        "status": "active",
        "company": "FOLDER_NAME",
        "user_from": {
            "id": "USER_ID",
            "email": "USER_EMAIL",
            "name": "USER_NAME"
        },
        "user_to": {
            "id": "USER_ID",

            "email": "USER_EMAIL",
            "name": "USER_NAME"
        },
        "text": "PROJECT_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",
        "options": {
            "allow_close": 0..1,
            "allow_give": 0..1,
            "allow_term": 0..1,
            "allow_limit": 0..1,
            "require_term": 0..1,
            "require_tag": 0..1,
            "require_limit": 0..1,
            "require_hidden": 0..1,
            "deny_comments_edit": 0..1,
            "deny_task_edit": 0..1,
            "deny_task_delete": 0..1,
            "time_require": 0..1,
            "time_today": 0..1,
            "timer_only": 0..1
        },
        "max_time": 100,
        "max_money": 500,
        "tags": {
            "TAG_ID": "TAG_NAME_1",
            "TAG_ID": "TAG_NAME_2"
        },
        "users": [
            {
                "id": "USER_ID",
                "email": "USER_EMAIL",
                "name": "USER_NAME_1"
            },
            {
                "id": "USER_ID",
                "email": "USER_EMAIL",
                "name": "USER_NAME_2"
            },
            {
                "id": "USER_ID",

                "email": "USER_EMAIL",
                "name": "USER_NAME_3"
            }
        ]
    }
}
Ця стаття була вам корисною? Так, дякую! Ні

Додавання людей до команди проєкту через API: add_project_members

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

https://youraccount.worksection.com/api/admin/v2/?action=add_project_members&
id_project=PROJECT_ID&members=USER_EMAIL_1,USER_EMAIL_2&hash=HASH
Додає учасників акаунту до команди обраного проєкту

Обов'язкові параметри:
  • id_project — ID проєкту
  • members — email користувачів (через кому)
Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok

{
    "status": "ok"
}
Ця стаття була вам корисною? Так, дякую! Ні

Виключення людей з команди проєкту через API: delete_project_members

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

https://youraccount.worksection.com/api/admin/v2/?action=delete_project_members
&id_project=PROJECT_ID&members=USER_EMAIL_1,USER_EMAIL_2&hash=HASH
Виключає учасників з команди обраного проєкту

Обов'язкові параметри:
  • id_project — ID проєкту
  • members — email користувачів (через кому)
Приклад JSON відповіді
При успішному виконанні запиту, відповідь буде містити статус ok

{
    "status": "ok"
}
Ця стаття була вам корисною? Так, дякую! Ні
esc
или
Роздрукувати