Skip to main content
GET
cURL
Возвращает список item_set, созданных в указанную дату или за период.

Параметры

  • project_id (int, path, обязательный) - ID проекта
  • date_from (date, query, опциональный) - Дата начала периода (YYYY-MM-DD)
  • date_to (date, query, опциональный) - Дата окончания периода (YYYY-MM-DD)
  • page (int, query, опциональный) - Номер страницы для пагинации
  • per_page (int, query, опциональный) - Количество элементов на странице

Примеры запросов

Пример 1: Получение всех item_set проекта

Пример 2: Фильтр с определенной даты

Пример 3: Фильтр до определенной даты

Пример 4: Фильтр по периоду

Пример 5: С пагинацией и фильтром по дате

Пример 6: За конкретный день

Возможные ошибки

  • 401 Unauthorized - Отсутствует или неверный токен аутентификации
  • 403 Forbidden - Проект не принадлежит текущему пользователю
  • 404 Not Found - Проект с указанным ID не найден
  • 422 Unprocessable Entity - Неверный формат даты в параметрах
  • 500 Internal Server Error - Внутренняя ошибка сервера

Логика фильтрации по дате

  • Если указан только date_from - возвращаются item_set с этой даты и позже
  • Если указан только date_to - возвращаются item_set до этой даты включительно
  • Если указаны оба параметра - возвращаются item_set в указанном диапазоне
  • Если параметры не указаны - возвращаются все item_set проекта

Статусы и их значения

Статусы item_set:

  • added - добавлен, ожидает обработки
  • processing - в процессе обработки
  • processed - успешно обработан
  • processing_failed - ошибка обработки

Статусы item_set в рамках проекта:

  • added - добавлен в проект
  • all_items_processed - все элементы обработаны
  • processing - в процессе обработки
  • processed - полностью обработан
  • processing_failed - ошибка обработки

Дополнительные примеры использования

Примеры обработки ошибок:

Ошибка аутентификации:

Ошибка доступа к проекту:

Ошибка валидации даты:

Authorizations

API-Access-Key
string
header
required

API-ключ для доступа к эндпоинтам

Path Parameters

project_id
integer
required

ID проекта

Query Parameters

date_from
string<date>

Дата начала периода (YYYY-MM-DD)

date_to
string<date>

Дата окончания периода (YYYY-MM-DD)

page
integer
default:1

Номер страницы для пагинации

per_page
integer
default:10

Количество элементов на странице

Response

Успешный ответ

item_sets
object[]
total_count
integer

Общее количество найденных item_set