Toggl Track (Независимый издатель) (предварительная версия)
Единственное программное обеспечение отслеживания времени, которое создает пользовательские отчеты из данных времени вашей команды, чтобы повысить производительность и доход. Наше решение отслеживания времени записывает временную шкалу календаря всех ваших рабочих действий в течение дня.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Трой Тейлор |
| URL | https://www.hitachisolutions.com |
| Адрес электронной почты | ttaylor@hitachisolutions.com |
| Метаданные соединителя | |
|---|---|
| Publisher | troystaylor |
| Веб-сайт | https://toggl.com/track/automated-time-tracker/ |
| Политика конфиденциальности | https://toggl.com/legal/track/privacy/ |
| Категории | Продуктивность |
Toggl Track
Единственное программное обеспечение отслеживания времени, которое создает пользовательские отчеты из данных времени вашей команды, чтобы повысить производительность и доход. Наше решение отслеживания времени записывает временную шкалу календаря всех ваших рабочих действий в течение дня.
Издатель: Трой Тейлор, Решения Похасти
Предпосылки
Необходимо зарегистрироваться для учетной записи с помощью Toggl.
Получение учетных данных
Этот соединитель использует обычную проверку подлинности с адресом электронной почты и паролем.
Поддерживаемые операции
Получение текущего пользователя
Возвращает сведения для текущего пользователя.
Обновление текущего пользователя
Обновляет сведения о текущем пользователе.
Получение клиентов пользователей
Получение клиентов для текущего пользователя.
Получение пользовательских функций
Получение функций, доступных текущему пользователю.
Получение расположения пользователя
Возвращает расположение на основе IP-адресов клиента. Если данные отсутствуют, возвращается пустой ответ.
Проверка подлинности
Используется для проверки того, работает ли проверка подлинности.
Получение организаций пользователей
Получение всех организаций, в которые входит данный пользователь.
Получение пользовательских проектов
Получение проектов для текущего пользователя.
Получение разбиения на страницы проектов пользователей
Получение проектов с разбивкой на страницы для текущего пользователя.
Получение тегов пользователей
Возвращает теги для текущего пользователя.
Получение задач пользователей
Возвращает задачи из проектов, в которых участвует пользователь.
Получение напоминаний о отслеживании
Возвращает список напоминаний о отслеживании.
Получение веб-таймера
Получение конфигурации веб-таймера.
Получение рабочих областей пользователей
Выводит список рабочих областей для данного пользователя.
Получение записей времени
Список последних записей времени.
Получение текущей записи времени
Загрузка записи времени выполнения для идентификатора пользователя.
Получение записи времени по идентификатору
Запись времени загрузки по идентификатору, доступному текущим пользователем.
Получение пользователей рабочей области (уровень организации)
Возвращает всех пользователей, принадлежащих рабочей области напрямую или по крайней мере через одну группу.
Получение пользователей рабочей области
Список всех пользователей для данной рабочей области.
Получение пользователей проекта рабочей области
Вывод списка всех пользователей проектов для данной рабочей области.
Получение клиентов пользователей
Получение клиентов для текущего пользователя.
Получение организаций пользователей
Получение всех организаций, в которые входит данный пользователь.
Получение пользователей рабочей области (уровень организации)
Возвращает всех пользователей, принадлежащих рабочей области напрямую или по крайней мере через одну группу.
Получение пользовательских проектов
Получение проектов для текущего пользователя.
Получение разбиения на страницы проектов пользователей
Получение проектов с разбивкой на страницы для текущего пользователя.
Получение пользователей проекта рабочей области
Вывод списка всех пользователей проектов для данной рабочей области.
Получение проектов рабочей области
Получение проектов для данной рабочей области.
Получение проекта рабочей области
Получение проекта для данной рабочей области.
Получение тегов пользователей
Возвращает теги для текущего пользователя.
Получение задач пользователей
Возвращает задачи из проектов, в которых участвует пользователь.
Получение рабочих областей пользователей
Выводит список рабочих областей для данного пользователя.
Создание записи времени
Создает новую запись времени рабочей области.
Удаление записи времени
Удаляет запись времени рабочей области.
Запись времени обновления
Обновляет запись времени рабочей области.
Записи времени массового редактирования
Записи времени массового редактирования. Исправление будет выполнено частично при возникновении ошибок с некоторыми записями. Нет транзакции, отката нет.
Остановка записи времени
Останавливает запись времени рабочей области.
Получение пользователей рабочей области (уровень организации)
Возвращает всех пользователей, принадлежащих рабочей области напрямую или по крайней мере через одну группу.
Получение одной рабочей области
Получение сведений об одной рабочей области.
Получение списка ставок
Получение ставок по уровню (рабочая область|project|task|user).
Получение статистики рабочей области
Возвращает список администраторов рабочей области, количество участников и число групп.
Получение ограничений для ввода времени рабочей области
Получение ограничений времени ввода для данной рабочей области.
Получение напоминаний о отслеживании рабочей области
Возвращает список напоминаний о отслеживании.
Получение пользователей рабочей области
Список всех пользователей для данной рабочей области.
Получение пользователей проекта рабочей области
Вывод списка всех пользователей проектов для данной рабочей области.
Получение проектов рабочей области
Получение проектов для данной рабочей области.
Получение проекта рабочей области
Получение проекта для данной рабочей области.
Получение записей времени
Список последних записей времени.
Получение текущей записи времени
Загрузка записи времени выполнения для идентификатора пользователя.
Получение записи времени по идентификатору
Запись времени загрузки по идентификатору, доступному текущим пользователем.
При создании записи времени
Активирует при создании новой записи времени в рабочей области.
При обновлении записи времени
Активирует при изменении существующей записи времени в рабочей области.
При удалении записи времени
Активирует при удалении записи времени из рабочей области.
При запуске записи времени
Активирует при запуске записи времени (начинается таймер) в рабочей области.
При остановке записи времени
Активирует при остановке записи во время выполнения в рабочей области.
Известные проблемы и ограничения
В настоящее время нет известных проблем.
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Имя пользователя | securestring | Имя пользователя для этого API | True |
| Пароль | securestring | Пароль для этого API | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Записи времени массового редактирования |
Записи времени массового редактирования. Исправление будет выполнено частично при возникновении ошибок с некоторыми записями. Нет транзакции, отката нет. |
| Запись времени обновления |
Обновляет запись времени рабочей области. |
| Обновление текущего пользователя |
Обновляет сведения о текущем пользователе. |
| Остановка записи времени |
Останавливает запись времени рабочей области. |
| Получение веб-таймера |
Получение конфигурации веб-таймера. |
| Получение задач пользователей |
Возвращает задачи из проектов, в которых участвует пользователь. |
| Получение записей времени |
Список последних записей времени. |
| Получение записи времени по идентификатору |
Запись времени загрузки по идентификатору, доступному текущим пользователем. |
| Получение клиентов пользователей |
Получение клиентов для текущего пользователя. |
| Получение напоминаний о отслеживании |
Возвращает список напоминаний о отслеживании. |
| Получение напоминаний о отслеживании рабочей области |
Возвращает список напоминаний о отслеживании. |
| Получение ограничений для ввода времени рабочей области |
Получение ограничений времени ввода для данной рабочей области. |
| Получение одной рабочей области |
Получение сведений об одной рабочей области. |
| Получение организаций пользователей |
Получение всех организаций, в которые входит данный пользователь. |
| Получение пользователей проекта рабочей области |
Вывод списка всех пользователей проектов для данной рабочей области. |
| Получение пользователей рабочей области |
Список всех пользователей для данной рабочей области. |
| Получение пользователей рабочей области (уровень организации) |
Возвращает всех пользователей, принадлежащих рабочей области напрямую или по крайней мере через одну группу. |
| Получение пользовательских проектов |
Получение проектов для текущего пользователя. |
| Получение пользовательских функций |
Получение функций, доступных текущему пользователю. |
| Получение проекта рабочей области |
Получение проекта для данной рабочей области. |
| Получение проектов рабочей области |
Получение проектов для данной рабочей области. |
| Получение рабочих областей пользователей |
Выводит список рабочих областей для данного пользователя. |
| Получение разбиения на страницы проектов пользователей |
Получение проектов с разбивкой на страницы для текущего пользователя. |
| Получение расположения пользователя |
Возвращает расположение на основе IP-адресов клиента. Если данные отсутствуют, возвращается пустой ответ. |
| Получение списка ставок |
Получение ставок по уровню (рабочая область|project|task|user). |
| Получение статистики рабочей области |
Возвращает список администраторов рабочей области, количество участников и число групп. |
| Получение тегов пользователей |
Возвращает теги для текущего пользователя. |
| Получение текущего пользователя |
Возвращает сведения для текущего пользователя. |
| Получение текущей записи времени |
Загрузка записи времени выполнения для идентификатора пользователя. |
| Проверка подлинности |
Используется для проверки того, работает ли проверка подлинности. |
| Создание записи времени |
Создает новую рабочую область TimeEntry. |
| Удаление записи времени |
Удаляет запись времени рабочей области. |
Записи времени массового редактирования
Записи времени массового редактирования. Исправление будет выполнено частично при возникновении ошибок с некоторыми записями. Нет транзакции, отката нет.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочей области
|
workspace_id | True | integer |
Числовые идентификаторы рабочей области. |
|
Идентификаторы записи времени
|
time_entry_ids | True | string |
Числовые идентификаторы time_entries, разделенные запятыми. Например: 204301830 202700150150 20268759. Ограничение составляет 100 идентификаторов на запрос. |
|
Включение метаданных
|
meta | boolean |
Если ответ содержит данные для метаданных сущностей. |
|
|
Операция
|
op | True | string |
Операция (add/remove/replace). |
|
Путь
|
path | True | string |
Путь к сущности для исправления (например, /description). |
|
Ценность
|
value | object |
Новое значение для сущности в пути. |
Возвращаемое значение
- Тело
- BulkEditResponse
Запись времени обновления
Обновляет запись времени рабочей области.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочей области
|
workspace_id | True | integer |
Числовые идентификаторы рабочей области. |
|
Идентификатор записи времени
|
time_entry_id | True | integer |
Идентификатор TimeEntry. |
|
Включение метаданных
|
meta | boolean |
Если ответ содержит данные для метаданных сущностей. |
|
|
Включение общего доступа
|
include_sharing | boolean |
Включите сведения о совместном доступе в ответ. |
|
|
К оплате
|
billable | boolean |
Указывает, помечена ли запись времени как оплачиваемая, необязательно, значение false по умолчанию. |
|
|
Создано с помощью
|
created_with | string |
Необходимо указать при создании записи времени и определить службу или приложение, используемое для его создания. |
|
|
Description
|
description | string |
Описание записи во времени, необязательно. |
|
|
Продолжительность
|
duration | integer |
Длительность записи во времени. Для выполняемых записей должно быть отрицательным, предпочтительнее –1. |
|
|
Только длительность
|
duronly | boolean |
Не рекомендуется: используется для создания записи времени с длительностью, но без времени остановки. Этот параметр можно игнорировать. |
|
|
Функция источника
|
origin_feature | string |
Имя функции источника. |
|
|
Число видимых целей
|
visible_goals_count | integer |
Количество видимых целей. |
|
|
Идентификаторы расходов
|
expense_ids | array of integer |
Затраты на работу, связанные с записью времени. |
|
|
Идентификатор проекта (устаревшая версия)
|
pid | integer |
Идентификатор проекта, устаревшее поле. |
|
|
Код проекта
|
project_id | integer |
Идентификатор проекта, необязательный. |
|
|
Общий доступ к идентификаторам пользователей
|
shared_with_user_ids | array of integer |
Список идентификаторов пользователей, с которыми можно предоставить общий доступ к записи этого времени. |
|
|
Время начала
|
start | string |
Время начала в формате UTC, необходимое для создания. Формат: 2006-01-02T15:04:05Z. |
|
|
Дата начала
|
start_date | string |
Если она указана во время создания, часть даты будет иметь приоритет над частью даты начала. Формат: 2006-11-07. |
|
|
Время остановки
|
stop | string |
Время остановки в формате UTC может быть опущено, если оно по-прежнему выполняется или создается с параметром "длительность". Если задано значение "stop" и "duration", значения должны быть согласованы (start + duration == stop). |
|
|
Действие тега
|
tag_action | string |
Может быть "добавить" или "удалить". Используется при обновлении существующей записи времени. |
|
|
Идентификаторы тегов
|
tag_ids | array of integer |
Идентификаторы тегов для добавления и удаления. |
|
|
Метки
|
tags | array of string |
Имена тегов для добавления и удаления. Если имя не существует в виде тега, он будет создан автоматически. |
|
|
Идентификатор задачи
|
task_id | integer |
Идентификатор задачи, необязательный. |
|
|
Идентификатор задачи (устаревшая версия)
|
tid | integer |
Идентификатор задачи, устаревшее поле. |
|
|
Идентификатор пользователя (устаревшая версия)
|
uid | integer |
Идентификатор создателя записи времени, устаревшее поле. |
|
|
Идентификатор пользователя
|
user_id | integer |
Идентификатор создателя записи времени, если опущен, будет использовать идентификатор пользователя запрашивающего пользователя. |
|
|
Идентификатор рабочей области (устаревшая версия)
|
wid | integer |
Идентификатор рабочей области, устаревшее поле. |
|
|
Идентификатор рабочей области
|
workspace_id | integer |
Идентификатор рабочей области, обязательный. |
Возвращаемое значение
- Тело
- TimeEntry
Обновление текущего пользователя
Обновляет сведения о текущем пользователе.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Начало недели
|
beginning_of_week | integer |
Первый день недели пользователя. Воскресенье: 0, понедельник: 1, и т. д. |
|
|
Идентификатор страны
|
country_id | integer |
Идентификатор страны пользователя. |
|
|
Текущий пароль
|
current_password | string |
Текущий пароль пользователя (используется для изменения текущего пароля). |
|
|
Идентификатор рабочей области по умолчанию
|
default_workspace_id | integer |
Идентификатор рабочей области пользователя по умолчанию. |
|
|
Адрес электронной почты
|
string |
Адрес электронной почты пользователя. |
||
|
Полное имя
|
fullname | string |
Полное имя пользователя. |
|
|
Новый пароль
|
password | string |
Новый пароль пользователя (текущий должен быть также указан). |
|
|
Timezone
|
timezone | string |
Часовой пояс пользователя. |
Возвращаемое значение
- Тело
- UserBasicResponse
Остановка записи времени
Останавливает запись времени рабочей области.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочей области
|
workspace_id | True | integer |
Числовые идентификаторы рабочей области. |
|
Идентификатор записи времени
|
time_entry_id | True | integer |
Идентификатор TimeEntry. |
Возвращаемое значение
- Тело
- TimeEntry
Получение веб-таймера
Получение конфигурации веб-таймера.
Получение задач пользователей
Возвращает задачи из проектов, в которых участвует пользователь.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Включение метаданных
|
meta | boolean |
Если ответ содержит данные для метаданных сущностей. |
|
|
Дата с даты
|
since | integer |
Извлеките элементы, созданные или измененные или удаленные с этой даты с помощью метки времени UNIX. |
|
|
Включение неактивных задач
|
include_not_active | string |
Включите задачи, помеченные как выполненные. |
|
|
Смещение разбиения на страницы
|
offset | integer |
Смещение для возобновления следующей разбивки на страницы. |
|
|
Элементы на страницу
|
per_page | integer |
Количество элементов на странице по умолчанию 201. |
Возвращаемое значение
- response
- array of Task
Получение записей времени
Список последних записей времени.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Включение метаданных
|
meta | boolean |
Если ответ содержит данные для метаданных сущностей. |
|
|
Включение общего доступа
|
include_sharing | boolean |
Включите сведения о совместном доступе в ответ. |
|
|
Дата с даты
|
since | integer |
Извлеките элементы, созданные или измененные или удаленные с этой даты с помощью метки времени UNIX. |
|
|
До даты
|
before | string |
Получение записей с временем начала до заданной даты (гггг-MM-DD) или времени в формате RFC3339. |
|
|
Дата начала
|
start_date | string |
Получение записей с временем начала с start_date гггг-MM-DD или с временем в RFC3339 формате. Для использования с end_date. |
|
|
Дата окончания
|
end_date | string |
Получение записей с временем начала до end_date гггг-MM-DD или времени в формате RFC3339. Для использования с start_date. |
Возвращаемое значение
- response
- array of TimeEntry
Получение записи времени по идентификатору
Запись времени загрузки по идентификатору, доступному текущим пользователем.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор записи времени
|
time_entry_id | True | integer |
Идентификатор TimeEntry. |
|
Включение метаданных
|
meta | boolean |
Если ответ содержит данные для метаданных сущностей. |
|
|
Включение общего доступа
|
include_sharing | boolean |
Включите сведения о совместном доступе в ответ. |
Возвращаемое значение
- Тело
- TimeEntry
Получение клиентов пользователей
Получение клиентов для текущего пользователя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Дата с даты
|
since | integer |
Извлеките элементы, созданные или измененные или удаленные с этой даты с помощью метки времени UNIX. |
Возвращаемое значение
- response
- array of Client
Получение напоминаний о отслеживании
Получение напоминаний о отслеживании рабочей области
Возвращает список напоминаний о отслеживании.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочей области
|
workspace_id | True | integer |
Числовые идентификаторы рабочей области. |
Возвращаемое значение
Получение ограничений для ввода времени рабочей области
Получение ограничений времени ввода для данной рабочей области.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочей области
|
workspace_id | True | integer |
Числовые идентификаторы рабочей области. |
Возвращаемое значение
- Тело
- TimeEntryConstraints
Получение одной рабочей области
Получение сведений об одной рабочей области.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочей области
|
workspace_id | True | integer |
Числовые идентификаторы рабочей области. |
Возвращаемое значение
- Тело
- Workspace
Получение организаций пользователей
Получение всех организаций, в которые входит данный пользователь.
Возвращаемое значение
- response
- array of Organization
Получение пользователей проекта рабочей области
Вывод списка всех пользователей проектов для данной рабочей области.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочей области
|
workspace_id | True | integer |
Числовые идентификаторы рабочей области. |
|
Идентификаторы проектов
|
project_ids | string |
Числовые идентификаторы проектов, разделенные запятыми. |
|
|
Идентификатор пользователя
|
user_id | string |
Числовой идентификатор пользователя, если переданный возвращает только пользователей проекта для проектов этого пользователя. |
|
|
Включение участников группы
|
with_group_members | boolean |
Включить участников группы. |
Возвращаемое значение
- response
- array of ProjectUser
Получение пользователей рабочей области
Список всех пользователей для данной рабочей области.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочей области
|
workspace_id | True | integer |
Числовые идентификаторы рабочей области. |
|
Исключить удаленный
|
exclude_deleted | boolean |
Исключите удаленные записи в ответе. |
Возвращаемое значение
- response
- array of WorkspaceUserSimple
Получение пользователей рабочей области (уровень организации)
Возвращает всех пользователей, принадлежащих рабочей области напрямую или по крайней мере через одну группу.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
organization_id | True | integer |
Числовые идентификаторы организации. |
|
Идентификатор рабочей области
|
workspace_id | True | integer |
Числовые идентификаторы рабочей области. |
|
Номер страницы
|
page | integer |
Номер страницы. |
|
|
Элементы на страницу
|
per_page | integer |
Количество элементов на странице по умолчанию 201. |
|
|
Фильтр настраиваемых ставок
|
custom_rates | boolean |
Возвращает только пользователей с пользовательской почасовой ставкой или без нее соответственно. |
|
|
Только активные пользователи
|
active | boolean |
Возвращает только активных пользователей. |
|
|
Фильтр имен
|
name | string |
Имя пользователя рабочей области для фильтрации по. |
|
|
Фильтр поиска
|
search | string |
Фильтр рабочей области по имени или электронной почте. |
Возвращаемое значение
- response
- array of WorkspaceUser
Получение пользовательских проектов
Получение проектов для текущего пользователя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Включение архива
|
include_archived | string |
Включите архивные проекты. |
|
|
Дата с даты
|
since | integer |
Извлеките элементы, созданные или измененные или удаленные с этой даты с помощью метки времени UNIX. |
Возвращаемое значение
- response
- array of Project
Получение пользовательских функций
Получение функций, доступных текущему пользователю.
Возвращаемое значение
- response
- array of WorkspaceFeatures
Получение проекта рабочей области
Получение проекта для данной рабочей области.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочей области
|
workspace_id | True | integer |
Числовые идентификаторы рабочей области. |
|
Код проекта
|
project_id | True | integer |
Числовые идентификаторы проекта. |
Возвращаемое значение
- Тело
- Project
Получение проектов рабочей области
Получение проектов для данной рабочей области.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочей области
|
workspace_id | True | integer |
Числовые идентификаторы рабочей области. |
|
Сортировка закреплена
|
sort_pinned | True | boolean |
Поместите закрепленные проекты в верхней части ответа. |
|
Только активные пользователи
|
active | boolean |
Возвращает только активных пользователей. |
|
|
Дата с даты
|
since | integer |
Извлеките элементы, созданные или измененные или удаленные с этой даты с помощью метки времени UNIX. |
|
|
К оплате
|
billable | boolean |
Фильтрация по состоянию выставления счетов. |
|
|
Идентификаторы пользователей
|
user_ids | array |
Идентификаторы пользователей для фильтрации. |
|
|
Идентификаторы клиентов
|
client_ids | array |
Идентификаторы клиентов для фильтрации по. |
|
|
Идентификаторы групп
|
group_ids | array |
Идентификаторы групп для фильтрации. |
|
|
Идентификаторы проектов
|
project_ids | string |
Числовые идентификаторы проектов, разделенные запятыми. |
|
|
Статусы
|
statuses | array |
Состояние проекта для фильтрации по. |
|
|
Фильтр имен
|
name | string |
Имя пользователя рабочей области для фильтрации по. |
|
|
Номер страницы
|
page | integer |
Номер страницы. |
|
|
Поле сортировки
|
sort_field | True | string |
Поле для сортировки. |
|
Порядок сортировки
|
sort_order | True | string |
Порядок сортировки (asc/desc). |
|
Только шаблоны
|
only_templates | True | boolean |
Возвращает только шаблоны проектов. |
|
Только мои проекты
|
only_me | boolean |
Получение только проектов, назначенных текущему пользователю. |
|
|
Элементы на страницу
|
per_page | integer |
Количество элементов на странице по умолчанию 201. |
Возвращаемое значение
- response
- array of Project
Получение рабочих областей пользователей
Выводит список рабочих областей для данного пользователя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Дата с даты
|
since | integer |
Извлеките элементы, созданные или измененные или удаленные с этой даты с помощью метки времени UNIX. |
Возвращаемое значение
- response
- array of Workspace
Получение разбиения на страницы проектов пользователей
Получение проектов с разбивкой на страницы для текущего пользователя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Запуск идентификатора проекта
|
start_project_id | integer |
Идентификатор проекта для возобновления следующей разбивки на страницы. |
|
|
Дата с даты
|
since | integer |
Извлеките элементы, созданные или измененные или удаленные с этой даты с помощью метки времени UNIX. |
|
|
Элементы на страницу
|
per_page | integer |
Количество элементов на странице по умолчанию 201. |
Возвращаемое значение
- response
- array of Project
Получение расположения пользователя
Возвращает расположение на основе IP-адресов клиента. Если данные отсутствуют, возвращается пустой ответ.
Возвращаемое значение
- Тело
- LocationResponse
Получение списка ставок
Получение ставок по уровню (рабочая область|project|task|user).
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочей области
|
workspace_id | True | integer |
Числовые идентификаторы рабочей области. |
|
Level
|
level | True | string |
Уровень ставок: рабочая область, проект, задача или пользователь. |
|
Идентификатор уровня
|
level_id | True | integer |
Числовые идентификаторы уровня сущности. |
|
Тип скорости
|
type | string |
Тип возвращаемых значений скорости: billable_rates или labor_costs. Значение по умолчанию — billable_rates. |
Возвращаемое значение
- response
- array of Rate
Получение статистики рабочей области
Возвращает список администраторов рабочей области, количество участников и число групп.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочей области
|
workspace_id | True | integer |
Числовые идентификаторы рабочей области. |
Возвращаемое значение
- Тело
- WorkspaceStatistics
Получение тегов пользователей
Возвращает теги для текущего пользователя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Дата с даты
|
since | integer |
Извлеките элементы, созданные или измененные или удаленные с этой даты с помощью метки времени UNIX. |
Возвращаемое значение
- response
- array of Tag
Получение текущего пользователя
Возвращает сведения для текущего пользователя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Включение связанных данных
|
with_related_data | boolean |
Получение связанных с пользователем данных (клиентов, проектов, задач, тегов, рабочих областей, записей времени и т. д.). |
Возвращаемое значение
- Тело
- UserResponse
Получение текущей записи времени
Загрузка записи времени выполнения для идентификатора пользователя.
Возвращаемое значение
- Тело
- TimeEntry
Проверка подлинности
Используется для проверки того, работает ли проверка подлинности.
Создание записи времени
Создает новую рабочую область TimeEntry.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочей области
|
workspace_id | True | integer |
Числовые идентификаторы рабочей области. |
|
Включение метаданных
|
meta | boolean |
Если ответ содержит данные для метаданных сущностей. |
|
|
К оплате
|
billable | boolean |
Указывает, помечена ли запись времени как оплачиваемая, необязательно, значение false по умолчанию. |
|
|
Создано с помощью
|
created_with | string |
Необходимо указать при создании записи времени и определить службу или приложение, используемое для его создания. |
|
|
Description
|
description | string |
Описание записи во времени, необязательно. |
|
|
Продолжительность
|
duration | integer |
Длительность записи во времени. Для выполняемых записей должно быть отрицательным, предпочтительнее –1. |
|
|
Только длительность
|
duronly | boolean |
Не рекомендуется: используется для создания записи времени с длительностью, но без времени остановки. Этот параметр можно игнорировать. |
|
|
Функция источника
|
origin_feature | string |
Имя функции источника. |
|
|
Число видимых целей
|
visible_goals_count | integer |
Количество видимых целей. |
|
|
Идентификаторы расходов
|
expense_ids | array of integer |
Затраты на работу, связанные с записью времени. |
|
|
Идентификатор проекта (устаревшая версия)
|
pid | integer |
Идентификатор проекта, устаревшее поле. |
|
|
Код проекта
|
project_id | integer |
Идентификатор проекта, необязательный. |
|
|
Общий доступ к идентификаторам пользователей
|
shared_with_user_ids | array of integer |
Список идентификаторов пользователей, с которыми можно предоставить общий доступ к записи этого времени. |
|
|
Время начала
|
start | string |
Время начала в формате UTC, необходимое для создания. Формат: 2006-01-02T15:04:05Z. |
|
|
Дата начала
|
start_date | string |
Если она указана во время создания, часть даты будет иметь приоритет над частью даты начала. Формат: 2006-11-07. |
|
|
Время остановки
|
stop | string |
Время остановки в формате UTC может быть опущено, если оно по-прежнему выполняется или создается с параметром "длительность". Если задано значение "stop" и "duration", значения должны быть согласованы (start + duration == stop). |
|
|
Действие тега
|
tag_action | string |
Может быть "добавить" или "удалить". Используется при обновлении существующей записи времени. |
|
|
Идентификаторы тегов
|
tag_ids | array of integer |
Идентификаторы тегов для добавления и удаления. |
|
|
Метки
|
tags | array of string |
Имена тегов для добавления и удаления. Если имя не существует в виде тега, он будет создан автоматически. |
|
|
Идентификатор задачи
|
task_id | integer |
Идентификатор задачи, необязательный. |
|
|
Идентификатор задачи (устаревшая версия)
|
tid | integer |
Идентификатор задачи, устаревшее поле. |
|
|
Идентификатор пользователя (устаревшая версия)
|
uid | integer |
Идентификатор создателя записи времени, устаревшее поле. |
|
|
Идентификатор пользователя
|
user_id | integer |
Идентификатор создателя записи времени, если опущен, будет использовать идентификатор пользователя запрашивающего пользователя. |
|
|
Идентификатор рабочей области (устаревшая версия)
|
wid | integer |
Идентификатор рабочей области, устаревшее поле. |
|
|
Идентификатор рабочей области
|
workspace_id | integer |
Идентификатор рабочей области, обязательный. |
Возвращаемое значение
- Тело
- TimeEntry
Удаление записи времени
Удаляет запись времени рабочей области.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочей области
|
workspace_id | True | integer |
Числовые идентификаторы рабочей области. |
|
Идентификатор записи времени
|
time_entry_id | True | integer |
Идентификатор TimeEntry. |
Триггеры
| При запуске записи времени |
Активирует при запуске записи времени (начинается таймер) в рабочей области. |
| При обновлении записи времени |
Активирует при изменении существующей записи времени в рабочей области. |
| При остановке записи времени |
Активирует при остановке записи во время выполнения в рабочей области. |
| При создании записи времени |
Активирует при создании новой записи времени в рабочей области. |
| При удалении записи времени |
Активирует при удалении записи времени из рабочей области. |
При запуске записи времени
Активирует при запуске записи времени (начинается таймер) в рабочей области.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочей области
|
workspace_id | True | integer |
Числовые идентификаторы рабочей области. |
|
Объект
|
entity | string |
Toggl Track business entity to filter. |
|
|
Действие
|
action | string |
Тип изменения, примененного к сущности. |
Возвращаемое значение
При обновлении записи времени
Активирует при изменении существующей записи времени в рабочей области.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочей области
|
workspace_id | True | integer |
Числовые идентификаторы рабочей области. |
|
Объект
|
entity | string |
Toggl Track business entity to filter. |
|
|
Действие
|
action | string |
Тип изменения, примененного к сущности. |
Возвращаемое значение
При остановке записи времени
Активирует при остановке записи во время выполнения в рабочей области.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочей области
|
workspace_id | True | integer |
Числовые идентификаторы рабочей области. |
|
Объект
|
entity | string |
Toggl Track business entity to filter. |
|
|
Действие
|
action | string |
Тип изменения, примененного к сущности. |
Возвращаемое значение
При создании записи времени
Активирует при создании новой записи времени в рабочей области.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочей области
|
workspace_id | True | integer |
Числовые идентификаторы рабочей области. |
|
Объект
|
entity | string |
Toggl Track business entity to filter. |
|
|
Действие
|
action | string |
Тип изменения, примененного к сущности. |
Возвращаемое значение
При удалении записи времени
Активирует при удалении записи времени из рабочей области.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор рабочей области
|
workspace_id | True | integer |
Числовые идентификаторы рабочей области. |
|
Объект
|
entity | string |
Toggl Track business entity to filter. |
|
|
Действие
|
action | string |
Тип изменения, примененного к сущности. |
Возвращаемое значение
Определения
UserResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Включена 2FA
|
2fa_enabled | boolean |
Состояние двухфакторной проверки подлинности. |
|
Токен API
|
api_token | string |
Маркер API будет опущен, если он пуст. |
|
Последнее обновление
|
at | string |
Метка времени последнего обновления. |
|
Обновлена авторизация
|
authorization_updated_at | string |
Метка времени последнего обновления объекта сеанса пользователя авторизации. |
|
Начало недели
|
beginning_of_week | integer |
Первый день недели пользователя (0=воскресенье, 1=понедельник и т. д.). |
|
Клиенты
|
clients | array of Client |
Клиенты, значение NULL, если with_related_data не задано значение true. |
|
Идентификатор страны
|
country_id | integer |
Идентификатор страны пользователя. |
|
Создано в
|
created_at | string |
Метка времени создания пользователя. |
|
Идентификатор рабочей области по умолчанию
|
default_workspace_id | integer |
Идентификатор рабочей области пользователя по умолчанию. |
|
Адрес электронной почты
|
string |
Адрес электронной почты пользователя. |
|
|
Полное имя
|
fullname | string |
Полное имя пользователя. |
|
Имеет пароль
|
has_password | boolean |
Имеет ли пользователь набор паролей. |
|
Идентификатор пользователя
|
id | integer |
ИД пользователя |
|
URL-адрес изображения
|
image_url | string |
URL-адрес изображения профиля пользователя. |
|
Хэш интеркома
|
intercom_hash | string |
Хэш интеркома будет опущен, если пуст. |
|
Поставщики OAuth
|
oauth_providers | array of string |
Поставщики OAuth, доступные пользователю. |
|
Электронная почта OpenID
|
openid_email | string |
Адрес электронной почты OpenID. |
|
Включено OpenID
|
openid_enabled | boolean |
Состояние проверки подлинности OpenID включено. |
|
Options
|
options | object |
Параметры пользователя будут опущены, если они пусты. |
|
Проекты
|
projects | array of Project |
Проекты, значение NULL, если with_related_data не задано значение true. |
|
Метки
|
tags | array of Tag |
Теги, значение NULL, если with_related_data не задано значение true. |
|
Tasks
|
tasks | array of Task |
Задачи, значение NULL, если with_related_data не задано значение true. |
|
Записи времени
|
time_entries | array of TimeEntry |
Записи времени, значение NULL, если with_related_data не задано значение true. |
|
Timezone
|
timezone | string |
Часовой пояс пользователя. |
|
Обновлено в
|
updated_at | string |
Метка времени последнего обновления пользователя. |
|
Пространства для работы
|
workspaces | array of Workspace |
Рабочие области, значение NULL, если with_related_data не задано значение true. |
UserBasicResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Включена 2FA
|
2fa_enabled | boolean |
Состояние двухфакторной проверки подлинности. |
|
Токен API
|
api_token | string |
Маркер API будет опущен, если он пуст. |
|
Последнее обновление
|
at | string |
Метка времени последнего обновления. |
|
Начало недели
|
beginning_of_week | integer |
Первый день недели пользователя. |
|
Идентификатор страны
|
country_id | integer |
Идентификатор страны пользователя. |
|
Создано в
|
created_at | string |
Метка времени создания пользователя. |
|
Идентификатор рабочей области по умолчанию
|
default_workspace_id | integer |
Идентификатор рабочей области пользователя по умолчанию. |
|
Адрес электронной почты
|
string |
Адрес электронной почты пользователя. |
|
|
Полное имя
|
fullname | string |
Полное имя пользователя. |
|
Имеет пароль
|
has_password | boolean |
Имеет ли пользователь набор паролей. |
|
Идентификатор пользователя
|
id | integer |
ИД пользователя |
|
URL-адрес изображения
|
image_url | string |
URL-адрес изображения профиля пользователя. |
|
Электронная почта OpenID
|
openid_email | string |
Адрес электронной почты OpenID. |
|
Включено OpenID
|
openid_enabled | boolean |
Состояние проверки подлинности OpenID включено. |
|
Options
|
options | object |
Параметры пользователя будут опущены, если они пусты. |
|
Timezone
|
timezone | string |
Часовой пояс пользователя. |
|
Обновлено в
|
updated_at | string |
Метка времени последнего обновления пользователя. |
Клиент
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Archived
|
archived | boolean |
Значение true, если клиент архивируется. |
|
Последнее обновление
|
at | string |
Когда было последнее обновление. |
|
Идентификатор создателя
|
creator_id | integer |
Идентификатор пользователя, создавшего клиент. |
|
Внешний справочник
|
external_reference | string |
Внешняя ссылка на сущность Track Client. |
|
Идентификатор клиента
|
id | integer |
Код клиента. |
|
Внешний идентификатор интеграции
|
integration_ext_id | string |
Внешний идентификатор связанной сущности во внешней системе. |
|
Внешний тип интеграции
|
integration_ext_type | string |
Внешний тип связанной сущности во внешней системе. |
|
Поставщик интеграции
|
integration_provider | object |
Поставщик, имеющий сущность, связанную с этой сущностью Toggl Track. |
|
Имя клиента
|
name | string |
Имя клиента. |
|
Примечания.
|
notes | string |
Заметки клиента. |
|
Permissions
|
permissions | array of string |
Список разрешений авторизации для этого клиента. |
|
Общее число
|
total_count | integer |
Общее поле для хранения общего количества. |
|
Идентификатор рабочей области
|
wid | integer |
Идентификатор рабочей области. |
Проект
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Active
|
active | boolean |
Является ли проект активным или архивным. |
|
Фактические часы
|
actual_hours | integer |
Фактические часы, потраченные на проект. |
|
Фактические секунды
|
actual_seconds | integer |
Фактические секунды, потраченные на проект. |
|
Последнее обновление
|
at | string |
Дата последнего обновления. |
|
Автоматические оценки
|
auto_estimates | boolean |
Включена автоматическая оценка. |
|
К оплате
|
billable | boolean |
Можно ли выставлять счета за проект. |
|
Может отслеживать время
|
can_track_time | boolean |
Можно ли отслеживать время для этого проекта. |
|
Идентификатор клиента (устаревшая версия)
|
cid | integer |
Поле устаревшего идентификатора клиента. |
|
Идентификатор клиента
|
client_id | integer |
Код клиента. |
|
Имя клиента
|
client_name | string |
Имя клиента. |
|
Цвет
|
color | string |
Цвет проекта. |
|
Создано в
|
created_at | string |
Дата создания. |
|
Валюта
|
currency | string |
Валюта проекта. |
|
Текущий период
|
current_period | object |
Текущий период проекта, функция premium. |
|
Дата окончания
|
end_date | string |
Дата окончания проекта. |
|
Предполагаемые часы
|
estimated_hours | integer |
Предполагаемые часы для проекта. |
|
Предполагаемые секунды
|
estimated_seconds | integer |
Предполагаемое количество секунд для проекта. |
|
Внешний справочник
|
external_reference | string |
Внешняя ссылка на сущность проекта отслеживания. |
|
Фиксированная плата
|
fixed_fee | double |
Фиксированная плата, функция "Премиум". |
|
Код проекта
|
id | integer |
Идентификатор проекта. |
|
Внешний идентификатор интеграции
|
integration_ext_id | string |
Внешний идентификатор связанной сущности во внешней системе. |
|
Внешний тип интеграции
|
integration_ext_type | string |
Внешний тип связанной сущности во внешней системе. |
|
Поставщик интеграции
|
integration_provider | object |
Поставщик, имеющий сущность, связанную с этой сущностью Toggl Track. |
|
Является частным
|
is_private | boolean |
Является ли проект частным. |
|
Имя проекта
|
name | string |
Имя проекта. |
|
Permissions
|
permissions | array of string |
Разрешения проекта. |
|
Закреплено
|
pinned | boolean |
Указывает, закреплен ли проект. |
|
Почасовая ставка
|
rate | double |
Почасовая ставка для проекта. |
|
Частота последнего обновления
|
rate_last_updated | string |
После последнего обновления скорости. |
|
Повторяется
|
recurring | boolean |
Является ли проект повторяющимся, функцией premium. |
|
Повторяющиеся параметры
|
recurring_parameters | array of RecurringParameter |
Повторяющиеся параметры проекта, функция premium. |
|
Дата начала
|
start_date | string |
Дата начала проекта. |
|
Состояние
|
status | string |
Состояние проекта (предстоящий, активный, завершенный, архивированный, удаленный). |
|
Template
|
template | boolean |
Является ли проект шаблоном. |
|
ИД шаблона
|
template_id | integer |
Идентификатор шаблона, если проект основан на шаблоне. |
|
Общее число
|
total_count | integer |
Общее количество найденных проектов. |
|
Идентификатор рабочей области (устаревшая версия)
|
wid | integer |
Поле прежних версий идентификатора рабочей области. |
|
Идентификатор рабочей области
|
workspace_id | integer |
Идентификатор рабочей области. |
Повторяющийсяparameter
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Настраиваемый период
|
custom_period | integer |
Настраиваемый период, используемый при значении поля "custom". |
|
Предполагаемые секунды
|
estimated_seconds | integer |
Предполагаемые секунды. |
|
Дата окончания параметра
|
parameter_end_date | string |
Дата окончания параметра. |
|
Дата начала параметра
|
parameter_start_date | string |
Повторяющаяся дата начала. |
|
Период
|
period | string |
Повторяющийся период. |
|
Дата начала проекта
|
project_start_date | string |
Дата начала проекта. |
Тег
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Последнее изменение
|
at | string |
После создания или последнего изменения. |
|
Идентификатор создателя
|
creator_id | integer |
Идентификатор пользователя, создавшего тег. |
|
Удалено в
|
deleted_at | string |
Когда был удален. |
|
Идентификатор тега
|
id | integer |
Идентификатор тега. |
|
Внешний идентификатор интеграции
|
integration_ext_id | string |
Внешний идентификатор связанной сущности во внешней системе. |
|
Внешний тип интеграции
|
integration_ext_type | string |
Внешний тип связанной сущности во внешней системе. |
|
Поставщик интеграции
|
integration_provider | object |
Поставщик, имеющий сущность, связанную с этой сущностью Toggl Track. |
|
Имя тега
|
name | string |
Имя тега. |
|
Permissions
|
permissions | array of string |
Разрешения тега. |
|
Идентификатор рабочей области
|
workspace_id | integer |
Идентификатор рабочей области. |
Задача
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Active
|
active | boolean |
False при выполнении задачи. |
|
Последнее изменение
|
at | string |
После создания или последнего изменения задачи. |
|
URL-адрес аватара
|
avatar_url | string |
URL-адрес аватара. |
|
Имя клиента
|
client_name | string |
Имя клиента. |
|
Предполагаемые секунды
|
estimated_seconds | integer |
Предполагаемое количество секунд для задачи. |
|
Идентификатор задачи
|
id | integer |
Идентификатор задачи. |
|
Внешний идентификатор интеграции
|
integration_ext_id | string |
Внешний идентификатор связанной сущности во внешней системе. |
|
Внешний тип интеграции
|
integration_ext_type | string |
Внешний тип связанной сущности во внешней системе. |
|
Поставщик интеграции
|
integration_provider | object |
Поставщик, имеющий сущность, связанную с этой сущностью Toggl Track. |
|
Имя задачи
|
name | string |
Имя задачи. |
|
Permissions
|
permissions | array of string |
Разрешения задачи. |
|
Выставление счетов за проект
|
project_billable | boolean |
Можно ли выставлять счета за проект. |
|
Цвет проекта
|
project_color | string |
Метаданные цвета проекта. |
|
Код проекта
|
project_id | integer |
Идентификатор проекта. |
|
Проект является частным
|
project_is_private | boolean |
Является ли проект частным. |
|
Имя проекта
|
project_name | string |
Имя проекта. |
|
Ставка
|
rate | double |
Ставка для этой задачи. |
|
Частота последнего обновления
|
rate_last_updated | string |
После последнего обновления скорости. |
|
Повторяется
|
recurring | boolean |
Является ли это повторяющейся задачей. |
|
Идентификатор учетных записей Toggl
|
toggl_accounts_id | string |
Идентификатор учетных записей Toggl. |
|
Отслеживаемые секунды
|
tracked_seconds | integer |
Значение tracked_seconds находится в миллисекундах, а не в секундах. |
|
Идентификатор пользователя
|
user_id | integer |
ИД пользователя |
|
Имя пользователя
|
user_name | string |
Имя пользователя. |
|
Идентификатор рабочей области
|
workspace_id | integer |
Идентификатор рабочей области. |
TimeEntry
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Последнее обновление
|
at | string |
После последнего обновления следует формат ISO 8601. |
|
К оплате
|
billable | boolean |
Указывает, помечена ли запись времени как оплачиваемая. |
|
Имя клиента
|
client_name | string |
Связанные метаданные сущностей. |
|
Description
|
description | string |
Описание записи времени. |
|
Продолжительность
|
duration | integer |
Длительность записи во времени. Для выполняемых записей должно быть отрицательным, предпочтительнее –1. |
|
Только длительность
|
duronly | boolean |
Используется для создания TE с длительностью, но без времени остановки. |
|
Идентификаторы расходов
|
expense_ids | array of integer |
Расходы на работу. |
|
Идентификатор записи времени
|
id | integer |
Идентификатор записи времени. |
|
Permissions
|
permissions | array of string |
Список разрешений. |
|
Идентификатор проекта (устаревшая версия)
|
pid | integer |
Идентификатор проекта, устаревшее поле. |
|
Project Active
|
project_active | boolean |
Активен ли проект. |
|
Выставление счетов за проект
|
project_billable | boolean |
Можно ли выставлять счета за проект. |
|
Цвет проекта
|
project_color | string |
Цвет проекта. |
|
Код проекта
|
project_id | integer |
Идентификатор проекта. |
|
Имя проекта
|
project_name | string |
Имя проекта. |
|
Общий доступ с помощью
|
shared_with | array of SharedWith |
Указывает, кому предоставлен общий доступ к записи времени. |
|
Время начала
|
start | string |
Время начала в формате UTC. |
|
Время остановки
|
stop | string |
Время остановки в формате UTC может иметь значение NULL, если он по-прежнему работает. |
|
Идентификаторы тегов
|
tag_ids | array of integer |
Идентификаторы тегов, null, если теги не были предоставлены или были удалены позже. |
|
Метки
|
tags | array of string |
Имена тегов, null, если теги не были предоставлены или удалены позже. |
|
Идентификатор задачи
|
task_id | integer |
Идентификатор задачи. |
|
Имя задачи
|
task_name | string |
Имя задачи. |
|
Идентификатор задачи (устаревшая версия)
|
tid | integer |
Идентификатор задачи, устаревшее поле. |
|
Идентификатор пользователя (устаревшая версия)
|
uid | integer |
Идентификатор создателя записи времени, устаревшее поле. |
|
URL-адрес аватара пользователя
|
user_avatar_url | string |
URL-адрес аватара пользователя. |
|
Идентификатор пользователя
|
user_id | integer |
Идентификатор создателя записи времени. |
|
Имя пользователя
|
user_name | string |
Имя пользователя. |
|
Идентификатор рабочей области (устаревшая версия)
|
wid | integer |
Идентификатор рабочей области, устаревшее поле. |
|
Идентификатор рабочей области
|
workspace_id | integer |
Идентификатор рабочей области. |
SharedWith
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Принято
|
accepted | boolean |
Принимается ли общий ресурс. |
|
Идентификатор пользователя
|
user_id | integer |
Идентификатор пользователя, которому предоставлен общий доступ. |
|
Имя пользователя
|
user_name | string |
Имя пользователя, которому предоставлен общий доступ. |
Workspace
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Число активных проектов
|
active_project_count | integer |
Число активных проектов. |
|
Администратор
|
admin | boolean |
Текущий пользователь является администратором рабочей области (не рекомендуется). |
|
Токен API
|
api_token | string |
Маркер API (не рекомендуется). |
|
Последнее изменение
|
at | string |
Метка времени последнего изменения рабочей области. |
|
Бизнес-рабочая область
|
business_ws | boolean |
Рабочая область в подписке Premium. |
|
Отправка CSV
|
csv_upload | object |
Отправка данных CSV. |
|
Валюта по умолчанию
|
default_currency | string |
Валюта по умолчанию, функция premium. |
|
По умолчанию почасовая ставка
|
default_hourly_rate | double |
По умолчанию почасовая ставка, функция premium. |
|
Отключение утверждений
|
disable_approvals | boolean |
Отключите утверждения в рабочей области. |
|
Отключение представления расписания
|
disable_timesheet_view | boolean |
Отключите представление расписания в рабочей области. |
|
Скрытие времени окончания начала
|
hide_start_end_times | boolean |
Скрытие времени начала и окончания. |
|
Включено iCal
|
ical_enabled | boolean |
Включена интеграция календаря. |
|
URL-адрес iCal
|
ical_url | string |
URL-адрес календаря. |
|
Идентификатор рабочей области
|
id | integer |
Идентификатор рабочей области. |
|
Последнее изменение
|
last_modified | string |
Последнее изменение данных в рабочей области. |
|
Ограничение общедоступных данных проекта
|
limit_public_project_data | boolean |
Ограничение общедоступных проектов в отчетах администраторам. |
|
URL-адрес логотипа
|
logo_url | string |
URL-адрес логотипа рабочей области. |
|
Максимальное количество дней хранения данных
|
max_data_retention_days | object |
Как далеко назад бесплатные рабочие области могут получить доступ к данным. |
|
Имя рабочей области
|
name | string |
Имя рабочей области. |
|
Только администраторы могут создавать проекты
|
only_admins_may_create_projects | boolean |
Только администраторы смогут создавать проекты. |
|
Только администраторы могут создавать теги
|
only_admins_may_create_tags | boolean |
Только администраторы смогут создавать теги. |
|
Только администраторы видят панель мониторинга группы
|
only_admins_see_team_dashboard | boolean |
Только администраторы смогут просматривать панель мониторинга группы. |
|
Идентификатор организации
|
organization_id | integer |
Идентификатор организации. |
|
Permissions
|
permissions | array of string |
Список разрешений. |
|
Премия
|
premium | boolean |
Рабочая область в подписке Starter. |
|
Выставление счетов по умолчанию для проектов
|
projects_billable_by_default | boolean |
По умолчанию выставляются счета за новые проекты. |
|
Проекты, применяемые к выставлению счетов
|
projects_enforce_billable | boolean |
Будет ли время отслеживания проектов применять выставление счетов, необходимое для соблюдения. |
|
Частные проекты по умолчанию
|
projects_private_by_default | boolean |
Параметр рабочей области для видимости проекта по умолчанию. |
|
Частота последнего обновления
|
rate_last_updated | string |
Метка времени последнего обновления частоты рабочей области. |
|
Свертывание отчетов
|
reports_collapse | boolean |
Следует ли свернуть отчеты по умолчанию. |
|
Role
|
role | string |
Роль текущего пользователя в рабочей области. |
|
Округление
|
rounding | integer |
Округление по умолчанию, функция premium. 0 - ближайшее, 1 - округление вверх, -1 - округление вниз. |
|
Округление минут
|
rounding_minutes | integer |
Округление по умолчанию в минутах, функция premium. |
|
Subscription
|
subscription | object |
Сведения о подписке (не рекомендуется). |
|
Приостановлено в
|
suspended_at | string |
Метка времени приостановки. |
|
Ограничения ввода времени
|
te_constraints | object |
Параметр ограничений для ввода времени. |
|
Рабочие часы в минутах
|
working_hours_in_minutes | integer |
Рабочие часы в минутах. |
Функция
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Включен
|
enabled | boolean |
Включена ли функция. |
|
Идентификатор функции
|
feature_id | integer |
Идентификатор компонента. |
|
Имя компонента
|
name | string |
Имя компонента. |
Рабочее пространствоОсобенности
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Функции
|
features | array of Feature |
Список функций. |
|
Идентификатор рабочей области
|
workspace_id | integer |
Идентификатор рабочей области. |
LocationResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Город
|
city | string |
Имя города. |
|
Координаты города
|
city_lat_long | string |
Широта города и долгота. |
|
Код страны
|
country_code | string |
Код страны. |
|
Имя страны
|
country_name | string |
Имя страны. |
|
Государство
|
state | string |
Состояние или регион. |
Организация
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Администратор
|
admin | boolean |
Указывает, является ли запрашивающий администратором организации. |
|
Последнее изменение
|
at | string |
Дата последнего изменения организации. |
|
Создано в
|
created_at | string |
Дата создания организации. |
|
Идентификатор организации
|
id | integer |
Идентификатор организации. |
|
Включена многорабочая область
|
is_multi_workspace_enabled | boolean |
Значение true, если задан параметр организации is_multi_workspace_enabled. |
|
Унифицирован
|
is_unified | boolean |
Единая организация. |
|
Максимальное количество дней хранения данных
|
max_data_retention_days | object |
Как далеко назад бесплатные рабочие области в этой организации могут получить доступ к данным. |
|
Максимальное количество рабочих областей
|
max_workspaces | integer |
Максимальное количество рабочих областей, разрешенных для организации. |
|
Название организации
|
name | string |
Имя организации. |
|
Владелец
|
owner | boolean |
Указывает, является ли запрашивающий владельцем организации. |
|
Permissions
|
permissions | array of string |
Разрешения организации. |
|
Тарифный план Enterprise
|
pricing_plan_enterprise | boolean |
План подписки — это корпоративный план. |
|
Идентификатор плана ценообразования
|
pricing_plan_id | integer |
Идентификатор плана организации. |
|
Название плана ценообразования
|
pricing_plan_name | string |
Имя плана подписки, на который в настоящее время находится организация. |
|
Приостановлено в
|
suspended_at | string |
Приостановлено ли в настоящее время организация. |
|
trial_info
|
trial_info | TrialInfo | |
|
Число пользователей
|
user_count | integer |
Количество пользователей организации. |
TrialInfo
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Может иметь пробную версию
|
can_have_trial | boolean |
Верно, если ни организация, ни владелец никогда не имели пробной версии. |
|
Последний идентификатор плана ценообразования
|
last_pricing_plan_id | integer |
Последний идентификатор плана ценообразования. |
|
Дата следующего платежа
|
next_payment_date | string |
Следующая дата оплаты. |
|
Trial
|
trial | boolean |
Является ли подписка организации в настоящее время пробной. |
|
Доступна пробная версия
|
trial_available | boolean |
Если пробная версия доступна для этой организации (не рекомендуется). |
|
Дата окончания пробной версии
|
trial_end_date | string |
Дата окончания пробной версии. |
|
Идентификатор плана пробной версии
|
trial_plan_id | integer |
Идентификатор плана пробной версии. |
TrackReminder
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Создано в
|
created_at | string |
Время создания напоминаний. |
|
Частота
|
frequency | integer |
Частота напоминания в днях должна иметь значение 1 или 7. |
|
Идентификаторы групп
|
group_ids | array of integer |
Идентификаторы групп для отправки напоминания. |
|
Идентификатор напоминания
|
reminder_id | integer |
Идентификатор напоминания. |
|
Порог
|
threshold | integer |
Пороговое значение — это количество часов, после которого будет отправлено напоминание. |
|
Идентификаторы пользователей
|
user_ids | array of integer |
Идентификаторы пользователей для отправки напоминания. |
|
Идентификатор рабочей области
|
workspace_id | integer |
Идентификатор рабочей области. |
TrackRemindersResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Отслеживание напоминаний
|
items | array of TrackReminder |
Возвращает список напоминаний о отслеживании. |
BulkEditResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Сбоев
|
failure | array of BulkEditFailure |
Список неудачных операций. |
|
Идентификаторы успешного выполнения
|
success | array of integer |
Идентификаторы, для которых исправление было успешно выполнено. |
BulkEditFailure
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор сбоя
|
id | integer |
Идентификатор, для которого произошел сбой операции исправления. |
|
Сообщение об ошибке
|
message | string |
Причина сбоя операции. |
WorkspaceUser
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Включена 2FA
|
2fa_enabled | boolean |
Флаг, указывающий, включена ли 2FA. |
|
Active
|
active | boolean |
Флаг, указывающий, принимает ли пользователь приглашение. |
|
Администратор
|
admin | boolean |
Флаг, указывающий, является ли пользователь администратором. |
|
Последнее обновление
|
at | string |
Метка времени последнего обновления. |
|
URL-адрес аватара
|
avatar_file_name | string |
URL-адрес аватара. |
|
Адрес электронной почты
|
string |
Электронная почта пользователя. |
|
|
Идентификаторы групп
|
group_ids | array of integer |
Список групп, к которому принадлежит пользователь. |
|
Идентификатор рабочей области пользователя
|
id | integer |
Идентификатор рабочей области пользователя. |
|
Неактивное
|
inactive | boolean |
Флаг, указывающий, деактивирован ли пользователь администратором рабочей области. |
|
Код приглашения
|
invitation_code | string |
Внутренний код приглашения. |
|
URL-адрес приглашения
|
invite_url | string |
Внутренний URL-адрес приглашения. |
|
Является прямым членом
|
is_direct | boolean |
Флаг, указывающий, является ли пользователь прямым членом рабочей области (не назначается рабочей области с помощью группы). |
|
Затраты на трудозатрат
|
labor_cost | double |
Затраты на труд, назначенные пользователю. |
|
Затраты на труд после последнего обновления
|
labor_cost_last_updated | string |
Метка времени последнего обновления затрат на трудозатрат. |
|
Имя
|
name | string |
Имя пользователя. |
|
Администратор организации
|
organization_admin | boolean |
Флаг, указывающий, является ли пользователь администратором внутри организации. |
|
Ставка
|
rate | double |
Ставка, назначенная пользователю. |
|
Частота последнего обновления
|
rate_last_updated | string |
Метка времени последнего обновления скорости. |
|
Role
|
role | string |
Роль пользователя. |
|
Идентификатор роли
|
role_id | integer |
Идентификатор роли. |
|
Timezone
|
timezone | string |
Часовой пояс пользователя. |
|
Глобальный идентификатор пользователя
|
uid | integer |
Глобальный идентификатор пользователя. |
|
Идентификатор пользователя
|
user_id | integer |
Альтернативное поле JSON userID, используемое только для пользователей get-organization-workspaces-workspaceusers. |
|
Просмотр изменяемых тарифов на выставление счетов
|
view_edit_billable_rates | boolean |
Флаги разрешений детализации скорости. Вступает в силу только роли с разрешениями условной частоты. |
|
Просмотр затрат на трудозатрат
|
view_edit_labor_costs | boolean |
Просмотр разрешения на изменение затрат на трудозатрат. |
|
Идентификатор рабочей области
|
wid | integer |
Идентификатор рабочей области. |
|
Рабочие часы в минутах
|
working_hours_in_minutes | integer |
Значение рабочих часов в минутах. |
|
Администратор рабочей области
|
workspace_admin | boolean |
Флаг, указывающий, является ли пользователь администратором в рабочей области. |
|
Идентификатор рабочей области
|
workspace_id | integer |
Альтернативное поле JSON userID, используемое только для пользователей get-organization-workspaces-workspaceusers. |
Ставка
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Сумма
|
amount | double |
Сумма ставки. |
|
Создано в
|
created_at | string |
Дата создания ставки. |
|
Идентификатор создателя
|
creator_id | integer |
Идентификатор создателя. |
|
Удалено в
|
deleted_at | string |
Дата удаления скорости, если значение null, это означает, что ставки активны. |
|
Дата окончания
|
end | string |
Время окончания ставки. |
|
Идентификатор скорости
|
id | integer |
Идентификатор скорости. |
|
Идентификатор запланированной задачи
|
planned_task_id | integer |
Идентификатор запланированной задачи, который применяется. |
|
Код проекта
|
project_id | integer |
Идентификатор проекта, который применяется. |
|
Идентификатор пользователя проекта
|
project_user_id | integer |
Идентификатор пользователя project, который применяется. |
|
Режим изменения скорости
|
rate_change_mode | string |
Режим изменения скорости. |
|
Дата начала
|
start | string |
Время начала скорости. |
|
Тип
|
type | string |
Тип скорости. |
|
Обновлено в
|
updated_at | string |
Дата последнего обновления ставки. |
|
Идентификатор рабочей области
|
workspace_id | integer |
Идентификатор рабочей области, который применяется. |
|
Идентификатор пользователя рабочей области
|
workspace_user_id | integer |
Идентификатор пользователя рабочей области, который применяется. |
WorkspaceStatistics
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Администраторы
|
admins | array of WorkspaceAdmin |
Список администраторов рабочей области. |
|
Число групп
|
groups_count | integer |
Количество групп в рабочей области. |
|
Число членов
|
members_count | integer |
Количество участников в рабочей области. |
WorkspaceAdmin
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя
|
name | string |
Имя администратора. |
|
Идентификатор пользователя
|
user_id | integer |
Идентификатор пользователя администратора. |
TimeEntryConstraints
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Обязательное описание
|
description_present | boolean |
Описание требуется для записей времени. |
|
Обязательный проект
|
project_present | boolean |
Проект требуется для записей времени. |
|
Обязательный тег
|
tag_present | boolean |
Тег требуется для записей времени. |
|
Требуется задача
|
task_present | boolean |
Задача требуется для записей времени. |
|
Ограничения включены
|
time_entry_constraints_enabled | boolean |
Ограничения ввода времени включены. |
WorkspaceUserSimple
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Адрес электронной почты
|
string |
Электронная почта пользователя. |
|
|
Полное имя
|
fullname | string |
Имя пользователя. |
|
Идентификатор пользователя
|
id | integer |
Глобальный идентификатор пользователя. |
|
Неактивное
|
inactive | boolean |
Неактивное указывает, деактивен ли пользователь в рабочей области. |
|
Активен
|
is_active | boolean |
IsActive указывает, присоединился ли пользователь к рабочей области. |
|
Является администратором (не рекомендуется)
|
is_admin | boolean |
Флаг, указывающий, является ли пользователь администратором (не рекомендуется). |
|
Role
|
role | string |
Роль пользователя. |
ProjectUser
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Последнее изменение
|
at | string |
Когда последний раз был изменен. |
|
Идентификатор группы (устаревшая версия)
|
gid | integer |
Идентификатор группы, устаревшее поле. |
|
Идентификатор группы
|
group_id | integer |
Идентификатор группы. |
|
Идентификатор пользователя проекта
|
id | integer |
Идентификатор пользователя проекта. |
|
Затраты на трудозатрат
|
labor_cost | double |
Затраты на труд для этого пользователя проекта. |
|
Затраты на труд после последнего обновления
|
labor_cost_last_updated | string |
Дата последнего обновления затрат на трудозатрат. |
|
Менеджер
|
manager | boolean |
Указывает, является ли пользователь руководителем проекта. |
|
Код проекта
|
project_id | integer |
Идентификатор проекта. |
|
Ставка
|
rate | double |
Частота для этого пользователя проекта. |
|
Частота последнего обновления
|
rate_last_updated | string |
Дата последнего обновления скорости. |
|
Идентификатор пользователя
|
user_id | integer |
ИД пользователя |
|
Идентификатор рабочей области
|
workspace_id | integer |
Идентификатор рабочей области. |
TimeEntryWebhookEvent
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор события
|
event_id | integer |
Уникальный идентификатор события веб-перехватчика. |
|
ID подписки
|
subscription_id | integer |
Идентификатор подписки веб-перехватчика, активировав это событие. |
|
Событие, созданное в
|
created_at | string |
Когда событие было создано. |
|
Метка времени события
|
timestamp | string |
Когда событие было отправлено. |
|
Идентификатор создателя
|
creator_id | integer |
Идентификатор пользователя, активировавшего событие. |
|
URL-адрес обратного вызова
|
url_callback | string |
URL-адрес обратного вызова для этого события. |
|
Тип запроса
|
metadata.request_type | string |
Тип запроса, активировав событие. |
|
Идентификатор пользователя события
|
metadata.event_user_id | integer |
Идентификатор пользователя, связанного с событием. |
|
Действие
|
metadata.action | string |
Действие, которое было выполнено (создано, обновлено, удалено, запущено, остановлено). |
|
payload
|
payload | TimeEntry |