Формат взаимодействия

В разделе Инструменты администратора → REST API отправьте запрос:

• Тип запроса: укажите нужный тип запроса:
• GET — получить данные;
• PUT — обновить сущесвующий ресурс или добавить новый;
• POST — загрузить данные на сервер;
• DELETE — удалить ресурс с указанным URL (id);
• PATCH — обновить только несколько полей ресурса без замены всего ресурса;
• REST API URL: http(s)://<адрес сервера>/api/v1/<path> (замените /api/v1/<path> на нужный эндпойнт).

При необходимости:

• заполните поле Данные;
• если нужно отправить запрос под учетной записью другого пользователя:
• установите чекбокс Выбрать пользователя;
• введите логин и пароль пользователя.

После отправки запроса под кнопками отобразится результат:

• status
• success — запрос выполнен;
• access denied — запрос не выполнен;
• message=сообщение об результатах запроса (опционально);
• "data": {} — данные (тип данных зависит от метода). Пример с успешным POST-запросом для загрузки содержимого JSON-файла из коллекции reports:

Сообщения об ошибках

В случае ошибки запроса возвращается JSON-объект со значением status=error и message=сообщение об ошибке.

Пример:

{
  "status": "error",
  "message": "You must be logged in to do this."
}