Общие принципы формирования запросов

При формировании запросов ключевыми методами являются:

• GET — получение данных из ресурса;

• POST — создание и размещение нового ресурса;

• PATCH — обновление ресурса, добавление одного или нескольких изменений в указанный фрагмент ресурса;

• DELETE — удаление ресурса.

Составляющие части пути запросов:

• api/v1 - префикс, с которого начинается путь любого запроса;

• :store - тип сущности:

  • models - модели;

  • objects - объекты;

  • automatons - логика;

  • handlers - обработчики;

  • labels - метки;

  • geofences - геозоны;

  • admin - администрирование проекта;

  • links - связи;

  • messages - сообщения;

  • users - пользователи;

  • groups - группы;

  • invites - приглашения;

  • roles - роли;

  • tokens - API токены;

  • geo - география.

• :id - идентификатор сущности, который представляет собой строку размером 12 байт (например, 58238a935baa56173b24f0e4). Он назначается системой в момент создания и в дальнейшем не может быть изменен. В API link каждой сущности этот идентификатор хранится в поле _id.