Отримання списку проектів через API: get_projects
Приклад get_projects запиту
https://your—domain.com/api/admin/v2/?action=get_projects&hash=HASH У цьому запиті параметр page не потрібен
Необов'язкові параметри:
- filter=active (pending, archive) — повертає дані проектів, які знаходяться у зазначеному статусі (активний/сплячий/архівний)
- extra — повертає додаткові дані по проекту (можна вказувати через кому, наприклад extra=text,options,users):
text або html — опис відповідно у текстовому або html форматі
options — масив даних щодо обмежень проекту
users — масив даних про учасників команди проекту
Повертаються дані по проектам:
- id — унікальний номер проекту
- name — назва проекту
- status — статус (active/pending/archive — активний/сплячий/архівний)
- 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 — змінювати заплановані витрати
- options.require_term — терміни
- options.require_tag — статуси і мітки
- options.require_limit — заплановані витрати
- options.require_hidden — видимість
- options.deny_comments_edit — редагувати і видаляти коментарі
- options.deny_task_edit — редагувати і видаляти завдання
- options.deny_task_delete — видаляти завдання
- options.time_require — не закривати завдання без витрат
- options.time_today — тільки за поточний день
- options.timer_only — тільки з таймера
- max_time і max_money — планові фінансові витрати (якщо вказано)
- tags — масив у форматі id: name для статусів і міток проекту (якщо вказано)
- users — список учасників команди проекту з інформацією по ним (якщо в запиті вказано параметр extra)
Виконавець може:
При постановці задачі вимагати PRO:
Користувачам заборонено PRO:
Внесення витрат PRO:
Приклад 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",
... ... ...
}
]}
Ця стаття була вам корисною?
Так, дякую!
Ні