Чтение коллекций

Обновлено: 21.06.2026

НазначениеНазначение

Чтение коллекций — базовая операция API Timetta, которая позволяет получать список записей сущности.

Для этого используется HTTP-метод GET к коллекции сущности.

Например, для получения списка проектов используется коллекция Projects:

GET https://api.timetta.com/odata/Projects

Базовый запросБазовый запрос

Простейший запрос:

GET https://api.timetta.com/odata/Projects

Пример ответа:

{
  "value": [
    {
      "name": "Business Process Optimization",
      "id": "2fa44ea0-df3b-47f0-bc62-fea3554c6c3c",
      "modified": "2022-09-04T11:06:03.775347Z",
      "manager": {
        "name": "Ace Fry",
        "id": "bcd753cc-0b80-47ae-a471-6ff7f06010e1"
      }
    }
  ]
}

Ответ всегда содержит массив объектов в свойстве value.

Выбор полей ($select)Выбор полей ($select)

Для ограничения набора возвращаемых данных можно использовать $select.

Например, получить только идентификатор, название и дату изменения:

GET https://api.timetta.com/odata/Projects?$select=id,name,modified

Это позволяет уменьшить размер ответа и ускорить обработку.

Ограничение количества ($top)Ограничение количества ($top)

Чтобы ограничить количество возвращаемых проектов:

GET https://api.timetta.com/odata/Projects?$top=10

Будут возвращены первые 10 записей.

Постраничное чтение ($skip)Постраничное чтение ($skip)

Для перехода по страницам используется $skip.

Например:

GET https://api.timetta.com/odata/Projects?$top=10&$skip=20

Запрос пропустит первые 20 проектов и вернёт следующие 10.

Это удобно при последовательной загрузке больших наборов данных.

Подсчёт количества ($count)Подсчёт количества ($count)

Если необходимо получить общее количество проектов:

GET https://api.timetta.com/odata/Projects?$count=true

Пример ответа:

{
  "@odata.count": 154,
  "value": [...]
}

Свойство @odata.count содержит общее количество записей.

Работа с навигационными свойствамиРабота с навигационными свойствами

Сущность Project содержит навигационные поля. Например, поле manager.

Для получения вложенных данных можно использовать $expand:

GET https://api.timetta.com/odata/Projects?$select=id,name&$expand=manager($select=id,name)

Пример ответа:

{
  "value": [
    {
      "id": "2fa44ea0-df3b-47f0-bc62-fea3554c6c3c",
      "name": "Business Process Optimization",
      "manager": {
        "id": "bcd753cc-0b80-47ae-a471-6ff7f06010e1",
        "name": "Ace Fry"
      }
    }
  ]
}

Это позволяет получать связанные сущности одним запросом.

Комбинирование параметровКомбинирование параметров

Параметры можно использовать совместно:

GET https://api.timetta.com/odata/Projects?$select=id,name,modified&$expand=manager($select=name)&$top=20&$skip=40&$count=true

Такой запрос:

• возвращает только нужные поля проекта;
• раскрывает руководителя проекта;
• ограничивает размер выборки;
• позволяет реализовать пагинацию;
• возвращает общее количество.

РекомендацииРекомендации

При чтении коллекций рекомендуется:

• использовать $select для ограничения набора полей;
• использовать $top и $skip для постраничной загрузки;
• использовать $expand только для действительно необходимых связанных данных;
• комбинировать фильтрацию и сортировку для уменьшения объёма выборки.