WORKSECTION

Таймеры

Получение списка активных таймеров через API: get_timers

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

?action=get_timers
Возвращает информацию по запущенным таймерам
*ID таймера, время запуска, время таймера и кто его запустил
Возвращаемые данные:
  • id — ID таймера
  • time — количество времени по таймеру (на момент отправки запроса)
  • date_started — дата и время запуска таймера
  • user_from — пользователь, запустивший таймер
  • task — данные о проекте и задаче, где запущен таймер (возвращаемые данные аналогичны полученным через метод get_task)

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

{
    "status": "ok",
    "data": [
        {
            "id": "TIMER_ID",
            "time": "HH:II:SS",
            "date_started": "YYYY—MM—DD HH:II",
            "user_from": {
                "id": "USER_ID",
                "email": "USER_EMAIL",
                "name": "USER_NAME"
            },
            "task": {
                "id": "TASK_ID",
                "name": "TASK_NAME",
                "page": "/project/PROJECT_ID/TASK_ID/",
                "status": "active",
                "priority": "1",
                "user_from": {
                    "email": "USER_EMAIL",
                    "name": "USER_NAME"
                },
                "user_to": {
                    "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",
                "time_end": "HH:II",
                "max_time": 20,
                "max_money": 500,
                "tags": {
                    "TAG_ID": "TAG_NAME_1",
                    "TAG_ID": "TAG_NAME_2" 
                }
            }
        },
        {
            "id": "TIMER_ID",
            "time": "HH:II:SS",
            ... ... ...
        }
    ]
}

Эта статья была вам полезна? Да, спасибо! Нет

Остановка запущенного таймера через API: stop_timer

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

?action=stop_timer&timer=TIMER_ID
Останавливает и сохраняет выбранный запущенный таймер

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

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

Получение активного таймера авторизованного пользователя через API: get_my_timer

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

?action=get_my_timer
Возвращает информацию по активному таймеру авторизованного пользователя (oauth2)

метод доступен только при использовании токена доступа
Возвращаемые данные:
  • time — количество времени по таймеру (на момент отправки запроса)
  • date_started — дата и время запуска таймера
  • task — данные о проекте и задаче, где запущен таймер (возвращаемые данные аналогичны полученным через метод get_task)

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

{
    "status": "ok",
    "data": [
        {
            "time": TIMER_VALUE,
            "date_started": "YYYY—MM—DD HH:II",
            "task": {
                "id": "TASK_ID",
                "name": "TASK_NAME",
                "page": "/project/PROJECT_ID/TASK_ID/",
                "status": "active",
                "priority": "1",
                "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"
            }
        }
    ]
}

Эта статья была вам полезна? Да, спасибо! Нет

Запуск таймера авторизованного пользователя через API: start_my_timer

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

?action=start_my_timer&id_task=TASK_ID
Запускает таймер авторизованного пользователя (oauth2) в указанном задании

метод доступен только при использовании токена доступа

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

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

Остановка таймера авторизованного пользователя через API: stop_my_timer

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

?action=stop_my_timer
Останавливает и сохраняет активный таймер авторизованного пользователя (oauth2)

метод доступен только при использовании токена доступа

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

{
    "status": "ok"
}
Эта статья была вам полезна? Да, спасибо! Нет
Вторжение России в Украину Worksection прекратил работу на территории РФ Почему?
esc
или
Распечатать