Получение данных о затратах времени и денег через API: get_costs
Пример get_costs запроса
https://your-domain.com/api/admin/v2/?action=get_costs&hash=HASH
Возвращает данные по внесенным временным и финансовым затратам задач и подзадач
При отсутствии параметра page будут получены затраты по всем проектам аккаунта
Необязательные параметры:
- page — возвращает затраты указанного проекта/задачи/подзадачи (см. формат ссылки)
- datestart и dateend — диапазон дат для поиска данных в формате DD.MM.YYYY (даты считаются включительно)
- is_timer — возвращает только те строки затрат, в которых время:
1 — внесено с таймера
0 — внесено вручную
- filter — дополнительный параметр для поиска (список операторов для работы с используемыми в filter данными см. search_tasks)
Возможные данные для использования
в filter (для метода get_costs):
- task=TASK_ID — возвращает данные определенной задачи/подзадачи по её ID (можно получить через методы get_all_tasks или get_tasks) (Integer)
- project=PROJECT_ID — возвращает данные по задачам определенного проекта по его ID (можно получить через метод get_projects) (Integer)
- comment — комментарий пользователя к затратам (String)
- dateadd или date_added — дата внесения затрат в формате 'DD.MM.YYYY'
Возвращаемые данные:
- id — уникальный номер строки затрат
- comment — комментарий пользователя к затратам
- time — значение временных затрат
- money — значение финансовых затрат
- date — дата внесения затрат
- is_timer — способ внесения временных затрат
- user_from — информация о сотруднике, который внес затраты
- task — массив данных по задаче/подзадаче, куда внесены затраты (значения параметров аналогичны описанным в методе get_task)
- total — суммарные значения отдельно по временным и финансовым затратам, полученным в ответе
true — получены с таймера
false — внесены вручную
Пример JSON ответа
При успешном выполнении запроса, ответ будет содержать статус ok и следующие данные:
{
"status": "ok",
"data": [
{
"id": "COSTS_ID_1",
"comment": "COSTS_COMMENT",
"time": "10:00",
"money": "100.00",
"date": "YYYY-MM-DD",
"is_timer": false,
"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": "0..10",
"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",
"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": "COSTS_ID_2",
"comment": "COMMENT_COSTS",
... ... ...
}
],
"total": {
"time": "HH:II",
"money": "10.01"
}
}
Эта статья была вам полезна?
Да, спасибо!
Нет