Page tree

Citypoint - контроль и аналитика автопарка

Skip to end of metadata
Go to start of metadata

Запрос очереди отчетов.

Запрос:

URL:

Запрос списка всех объект:

GET https://api.url/v2.1/user/<user_id>/reports/queue

Запрос объекта по id

GET https://api.url/v2.1/user/<user_id>/reports/queue/<queue_id>

Доп. Параметры запроса:

               Поддерживаются стандартные параметры запроса page, sort, filter, fields, include.

         Доп. Заголовки:

If-Modified-Since - Если запрос ранее уже выполнялся, то при обновлении следует указывать заголовок If-Modified-Since с датой полученной заголовка ответа Last-Modified

Accept - для указания формата ответа. Должен быть "application/vnd.api+json", для совместимости принимается также "application/json".

Authorization - для передачи токена. Передается в формате: Bearer <access_token>.

Ответ:

     Ответ присылается в формате JSON API.

ПолеОписание
links

Поле links содержит ссылку на текущий ресурс (self).

metaСодержит total_count - количество объектов в системе
data

Содержит массив объектов  в формате JSON API.

Поля объектов:

ПолеТипОписание
idintИдентификатор (передаётся как строка для соответствия JSON API)
typestringТип ресурса (всегда "reportQueue")
attributesobjectДанные объекта (см. Описание атрибутов)

Описание атрибутов:

ПолеТипnullableфильтрацияописание
Progressintдада

Процент готовности отчета

0 - Отчет только начался строится

100 - Отчет готов

Statusstringнетда

Статус отчета

  • new (всегда ставится при создании)
  • in_action - в процессе построение
  • complete - отчет построен
  • cancel - отчет отменён пользователем
  • error - отчет не удалось сформировать, некорректные данные
  • need_restart - Отчет не удалось сформировать или сохранить на nfs, задача будет автоматически пересчитана повторно, через определённый промежуток времени
  • cancel_too_long - Отменен так как рассчитывается слишком долго, может быть выставлен администратором системы, если отчет создаёт проблемную нагрузку или есть подозрение на ошибку.
DateOfCreationdatetimeнетдаДата добавления отчета в очередь
StartDatedatetimeдада

Дата начала построения отчета

EndDatedatetimeдадаДата окончания построения отчета

Связанные объекты:

ПолеТипnullableфильтрацияописание
TaskreportTaskнетда

Ссылка на задачу отчета.

Также доступна фильтрация по данным связанного объекта.

Reportreportнетда

Ссылка на отчет.

Также доступна фильтрация по данным связанного объекта

Коды ответов:

200 ОК - Сервер обработал запрос. В теле содержится ответ в формате JSON API.

304 Not Modified - Сервер обработал запрос. Изменения не найдены.

401 Unauthorized - не передан заголовок Authorization, либо не корректный токен либо закончился период его действия.

403 Forbidden - нет прав на просмотр (id пользователя не соответствует токену ).

404 Not Found - запрошенный объект не найден.

400 Bad Request - Переданы не поддерживаемые параметры либо сервер не понял запрос (описание ошибки в теле ответа).


Пример:

Запрос списка задач:

GET https://api.url/v2.1/user/1/reports/queue HTTP/1.1
Accept: application/vnd.api+json

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
Allow: GET
Last-Modified: Wed, 21 Oct 2015 07:28:00 GMT

{
    "links": {
        "self": "https://api.url/user/1/reports/queue"
    },
    "meta": {
        "total_count": 7
    },
    "data": [
        {
            "id": "5081242",
            "type": "reportQueue",
            "attributes": {
                "Progress": 100,
                "Status": "complete",
                "DateOfCreation": "2022-06-15T14:04:55Z",
                "StartDate": "2022-06-15T14:04:56Z",
                "EndDate": "2022-06-15T14:05:02Z"
            },
            "relationships": {
                "Report": {
                    "data": {
                        "id": "10",
                        "type": "report"
                    }
                },
                "ReportTask": {
                    "data": {
                        "id": "5086955",
                        "type": "reportTask"
                    }
                }
            }
        },
         ...
     ]
}


  • No labels