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"
}
Ця стаття була вам корисною? Так, дякую! Ні
esc
или
Роздрукувати