Получение списка проектов через 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",
... ... ...
}
]}