Download PDF
Download page REST API. Доступные команды модуля «webui» портала «Агрегатор».
REST API. Доступные команды модуля «webui» портала «Агрегатор»
Доступные команды модуля «webui» портала «Агрегатор»
Команды, связанные с событиями аудита портала «Агрегатор»
Доступные администратору URL-команды перечислены в таблице.
| URL-команда | Тип | Описание |
|---|---|---|
| GET | Возвращает список событий аудита |
Команды, связанные с доменами аутентификации портала «Агрегатор»
Доступные администратору URL-команды перечислены в таблице.
| URL-команда | Тип | Описание |
|---|---|---|
| GET | Возвращает список доменов аутентификации |
| POST | Создает домен аутентификации |
| GET | Возвращает список групп домена аутентификации |
| POST | Создает группу домена аутентификации |
| GET | Возвращает группу с идентификатором {id} домена аутентификации с идентификатором {auth_id} |
| PUT | Обновляет группу с идентификатором {id} домена аутентификации с идентификатором {auth_id} |
| PATCH | Обновляет группу с идентификатором {id} домена аутентификации с идентификатором {auth_id} |
| DELETE | Удаляет группу с идентификатором {id} домена аутентификации с идентификатором {auth_id} |
| GET | Возвращает список пользователей домена аутентификации |
| POST | Создает пользователя домена аутентификации |
| GET | Возвращает пользователя с идентификатором {id} домена аутентификации с идентификатором {auth_id} |
| PUT | Обновляет пользователя с идентификатором {id} домена аутентификации с идентификатором {auth_id} |
| PATCH | Обновляет пользователя с идентификатором {id} домена аутентификации с идентификатором {auth_id} |
| DELETE | Удаляет пользователя с идентификатором {id} домена аутентификации с идентификатором {auth_id} |
| GET | Возвращает домен аутентификации с идентификатором {id} |
| PUT | Обновляет домен аутентификации с идентификатором {id} |
| PATCH | Обновляет домен аутентификации с идентификатором {id} |
| DELETE | Удаляет домен аутентификации с идентификатором {id} |
| GET | Возвращает журнал домена аутентификации с идентификатором {id} |
| GET | Возвращает описание для графического интерфейса домена аутентификации с типом {data_type} |
| POST | Тестирует параметры домена аутентификации |
| GET | Возвращает список доступных типов доменов аутентификации |
Команды, связанные с сертификатами портала «Агрегатор»
Доступные администратору URL-команды перечислены в таблице.
| URL-команда | Тип | Описание |
|---|---|---|
| GET | Возвращает список сертификатов |
| POST | Создает сертификат |
| GET | Возвращает сертификат с идентификатором {id} |
| PUT | Обновляет сертификат с идентификатором {id} |
| PATCH | Обновляет сертификат с идентификатором {id} |
| DELETE | Удаляет сертификат с идентификатором {id} |
Команды, связанные с панелью мониторинга портала «Агрегатор»
Доступные администратору URL-команды перечислены в таблице.
| URL-команда | Тип | Описание |
|---|---|---|
| GET | Просмотр списка объектов панели мониторинга |
Команды, связанные с фермами-поставщиками ресурсов портала «Агрегатор»
Доступные администратору URL-команды перечислены в таблице.
| URL-команда | Тип | Описание |
|---|---|---|
| GET | Возвращает список ферм-поставщиков ресурсов |
| POST | Создает ферму-поставщик ресурсов |
| GET | Возвращает ферму-поставщиков ресурсов с идентификатором {id} |
| PUT | Обновляет ферму-поставщиков ресурсов с идентификатором {id} |
| PATCH | Обновляет ферму-поставщиков ресурсов с идентификатором {id} |
| DELETE | Удаляет ферму-поставщиков ресурсов с идентификатором {id} |
| GET | Способ получения списка ферм-поставщиков ресурсов |
| GET | Способ просмотра подробных параметров фермы-поставщика ресурсов с идентификатором {id} с отрисовкой в HTML |
Команды, связанные со шлюзами портала «Агрегатор»
Доступные администратору URL-команды перечислены в таблице.
| URL-команда | Тип | Описание |
|---|---|---|
| GET | Возвращает список объектов («Шлюзов»), добавленных на портал «Агрегатор» |
| POST | Создает объект («Шлюз») |
| GET | Возвращает объект («Шлюз») с идентификатором {id} |
| PUT | Обновляет объект («Шлюз») с идентификатором {id} |
| PATCH | Обновляет объект («Шлюз») с идентификатором {id} |
| DELETE | Удаляет объект («Шлюз») с идентификатором {id} |
Команды, связанные с шаблонами техобслуживания
Доступные администратору URL-команды перечислены в таблице.
| URL-команда | Тип | Описание |
|---|---|---|
| GET | Возвращает список шаблонов техобслуживания, добавленных на портал «Агрегатор» |
| POST | Создает шаблон техобслуживания |
| GET | Возвращает шаблон техобслуживания с идентификатором {id} |
| PUT | Обновляет шаблон техобслуживания с идентификатором {id} |
| PATCH | Обновляет шаблон техобслуживания с идентификатором {id} |
| DELETE | Удаляет шаблон техобслуживания с идентификатором {id} |
Команды, связанные с функциями мониторинга портала «Агрегатор»
Доступные администратору URL-команды перечислены в таблице.
| URL-команда | Тип | Описание |
|---|---|---|
| GET | Просмотр всех записей журнала в виде списка |
| POST | Добавляет запись в журнал |
| GET | Просмотр записи журнала с идентификатором {id} |
| PUT | Обновляет запись журнала с идентификатором {id} |
| PATCH | Обновляет запись журнала с идентификатором {id} |
| DELETE | Удаляет запись журнала с идентификатором {id} |
Команды, связанные с группами пользователей
Доступные администратору URL-команды перечислены в таблице.
| URL-команда | Тип | Описание |
|---|---|---|
| GET | Возвращает список групп |
| POST | Создает группу |
| GET | Возвращает группу с идентификатором {id} |
| PUT | Обновляет группу с идентификатором {id} |
| PATCH | Обновляет группу с идентификатором {id} |
| DELETE | Удаляет группу с идентификатором {id} |
Команды, связанные с узлами портала «Агрегатор»
Доступные администратору URL-команды перечислены в таблице.
| URL-команда | Тип | Описание |
|---|---|---|
| GET | Возвращает список узлов |
| POST | Добавляет узел |
| GET | Возвращает узел с идентификатором {id} |
| PUT | Обновляет узел с идентификатором {id} |
| PATCH | Обновляет узел с идентификатором {id} |
| DELETE | Удаляет узел с идентификатором {id} |
Команды, связанные с объединенными наборам ресурсов сайтов портала «Агрегатор»
Доступные администратору URL-команды перечислены в таблице.
| URL-команда | Тип | Описание |
|---|---|---|
| GET | Возвращает список объединенных наборов ресурсов |
| POST | Добавляет объединенный набор ресурсов |
| GET | Возвращает объединенный набор ресурсов с идентификатором {id} |
| PUT | Обновляет объединенный набор ресурсов с идентификатором {id} |
| PATCH | Обновляет объединенный набор ресурсов с идентификатором {id} |
| DELETE | Удаляет объединенный набор ресурсов с идентификатором {id} |
| GET | Способ получения списка объединенных наборов ресурсов |
| POST | Способ просмотра списка объединенных наборов ресурсов с отрисовкой в HTML |
Команды, связанные с сайтами портала «Агрегатор»
Доступные администратору URL-команды перечислены в таблице.
| URL-команда | Тип | Описание |
|---|---|---|
| GET | Возвращает список сайтов |
| POST | Добавляет сайт |
| GET | Возвращает сайт с идентификатором {id} |
| PUT | Обновляет сайт с идентификатором {id} |
| PATCH | Обновляет сайт с идентификатором {id} |
| DELETE | Удаляет сайт с идентификатором {id} |
| GET | Способ предоставления всех ферм сайта с идентификатором {id} |
| GET | Способ предоставления всех правил (объединенных наборов ресурсов) сайта с идентификатором {id} |