Управление конфигурационными единицами
Получение доступных типов КЕ
GET /api/public/sm/v2/rsm/config-item-types
Запрос возвращает список моделей типов КЕ.
Получение доступных рабочих групп
GET /api/public/sm/v2/rsm/work-groups
Запрос возвращает список моделей рабочих групп.
Получение всех доступных КЕ
GET /api/public/sm/v2/rsm/config-items?page=1&perPage=-1&search=sample&sortCol=id&sortDir=asc&skip=0
Запрос возвращает список моделей КЕ с минимальным набором атрибутов: идентификатор id
и имя name
.
Параметры запроса
Название параметра | Тип параметра | Обязательный параметр | Значение по умолчанию | Описание параметра |
---|---|---|---|---|
page | integer | нет | null | Номер страницы |
perPage | integer | нет | null | Количество записей на одну страницу. Если -1 - будут возвращены все КЕ |
search | string | нет | null | Строка поиска |
sortCol | string | нет | null | Название поля, по которому выполняется сортировка |
sortDir | string | нет | null | Направление сортировки (asc/desc) |
skip | integer | нет | null | Количество записей, которое требуется пропустить |
Получение КЕ по идентификатору
GET /api/public/sm/v2/rsm/config-items/{id}?includeState=false&includeHealth=false
Запрос возвращает модель КЕ, запрошенной по идентификатору.
Параметры запроса
Название параметра | Тип параметра | Обязательный параметр | Значение по умолчанию | Описание параметра |
---|---|---|---|---|
id | integer | да | нет | Идентификатор КЕ |
includeState | boolean | нет | false | Включить информацию по статусу КЕ |
includeHealth | boolean | нет | false | Включить информацию по здоровью КЕ |
Коды ответов
Код ответа | Описание |
---|---|
400 | Неправильный идентификатор КЕ |
403 | У вас недостаточно прав для чтения КЕ |
404 | КЕ с идентификатором {id} не найдена |