WORKSECTION

Проекты

Получение списка проектов через API: get_projects

Пример get_projects запроса

?action=get_projects
Возвращает данные по всем проектам

Необязательные параметры:
  • 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): 
    • Исполнитель может:
  • 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: get_project

Пример get_project запроса

?action=get_project&id_project=PROJECT_ID
Возвращает данные выбранного проекта

Обязательные параметры:
  • 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):
    • Исполнитель может:
  • 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: post_project

Пример post_project запроса

?action=post_project&title=PROJECT_NAME
Создает проект
*позволяет прикреплять файлы (см. детальнее)

Обязательные параметры:
  • 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: update_project

Пример update_project запроса

?action=update_project&id_project=PROJECT_ID
Редактирует параметры указанного проекта

Обязательные параметры:
  • 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: close_project

Пример close_project запроса

?action=close_project&id_project=PROJECT_ID
Архивирует указанный проект

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

{
    "status": "ok"
}
Эта статья была вам полезна? Да, спасибо! Нет

Активация проекта API: activate_project

Пример activate_project запроса 

?action=activate_project&id_project=PROJECT_ID

Активирует указанный архивный проект


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

{
    "status": "ok"
}
Эта статья была вам полезна? Да, спасибо! Нет

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

Пример add_project_members запроса

?action=add_project_members&id_project=PROJECT_ID&
members=USER_EMAIL_1,USER_EMAIL_2
Добавляет участников аккаунта в команду выбранного проекта

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

{
    "status": "ok"
}
Эта статья была вам полезна? Да, спасибо! Нет

Исключение людей из команды проекта через API: delete_project_members

Пример delete_project_members запроса

?action=delete_project_members&id_project=PROJECT_ID&
members=USER_EMAIL_1,USER_EMAIL_2
Исключает участников из команды выбранного проекта

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

{
    "status": "ok"
}
Эта статья была вам полезна? Да, спасибо! Нет

Получение списка папок проектов через API: get_project_groups

Пример get_project_groups запроса

?action=get_project_groups
Возвращает данные по всем папкам проектов
Возвращаемые данные:
  • 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 запроса

?action=add_project_group&title=PROJECT_GROUP
Создает папку для проектов
*при отсутствие папки с аналогичным названием

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

{
    "status": "ok",
    "data": {
        "id": "GROUP_ID",
        "title": "GROUP_NAME",
        "type": "folder"
    }
}
Эта статья была вам полезна? Да, спасибо! Нет

Получение истории событий за период времени через API: get_events

Пример get_events запроса

?action=get_events&period=3d
Возвращает данные по выполненным действиям по всем или отдельному проекту за указанный период времени
*что, когда и кем изменено

Советуем использовать вебхуки вместо этого метода (см. детальнее)
Обязательные параметры:
  • 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"
            }
        }
    ]
}
Эта статья была вам полезна? Да, спасибо! Нет
Вторжение России в Украину Worksection прекратил работу на территории РФ Почему?
esc
или
Распечатать