...
| Название | https запрос | путь | параметры пути |
|---|
| получение списка ресурсов | GET | /realm/{realm_id}/resource/ | - realm (раздел) определяет набор доступных ресурсов и операций над ними. Определяется типом авторизованного пользователя. Может принимать значения
- client (соответствует пользователю типа "клиент")
- extension_group (соответствует пользователю типа "группа добавочных")
- extension (соответствует пользователю типа "добавочный"
Пользователь вышестоящего уровня может использовать ресурсы нижестоящего уровня. Например пользователь уровня "клиент" может использовать ресурс "GET /extension/{extension_id}/phone/" - realm_id идентификатор ресурса, к которому привязан авторизованный пользователь. Для пользователя типа "клиент"(/user/client/) - идентификатор ресурса /client/, для пользователя типа "группа добавочных"(/user/extension_group/) - идентификатор /extension_group/, для пользователя типа "добавочный"(/user/extension/ ) - идентификатор (/extension/).
Если realm и тип авторизованного пользователя совпадают, то в качестве realm_id может выступать значение "@me". Например, пользователь типа "добавочный" может сделать запрос "GET /extension/@me/phone/", а для пользователя типа "клиент" этот запрос будет не корректен - resource название ресурса
- resource_id уникальный идентификатор ресурса
|
| добавление ресурса | POST | /realm/{realm_id}/resource/ |
| получение ресурса по идентификатору | GET | /realm/{realm_id}/resource/{resource_id} |
| изменение ресурса | PUT | /realm/{realm_id}/resource/{resource_id} |
| удаление ресурса по идентификатору | DELETE | /realm/{realm_id}/resource/{resource_id} |
Некоторые ресурсы могут не содержать в пути realm и realm_id. Такие ресурсы не зависят от типа клиента, их использующего, например /timezone/ для получения списка поддерживаемых временных зон.
Набор методов не всегда полный и зависит от ресурса.
Получение списка ресурсов
...