Жизненный цикл КЕ и их обслуживание
В этом разделе описаны функции для управления жизненным циклом КЕ и их обслуживанием, включая функции перевода КЕ по стадиям и механизмы получения, создания и обновления режимов обслуживания.
Функции управления жизненным циклом КЕ
SetStageById
Назначение: Управление стадией жизненного цикла КЕ
Описание: Функция выполняет запрос к API [POST] /api/public/sm/v2/rsm/config-items/{id}/stages для перевода КЕ по жизненному циклу.
Inputs
| Название | Тип | Описание |
|---|---|---|
| In, BearerToken | Общие параметры для функций | |
| ConfigItemId | Integer64 | Идентификатор КЕ |
| StageId | Integer64 | Идентификатор стадии жизненного цикла |
| ApplyGrants | Boolean | Если задано True – применить настройки доступа к подчиненным КЕ. По умолчанию: False. |
Outputs
| Название | Тип | Описание |
|---|---|---|
| Ok, Failed, Response | Общие параметры для функций | |
| Stage | Struct: Automaton.CMDB.Stage | Модель стадии жизненного цикла, на которой сейчас находится КЕ |
SetStageByCategory
Назначение: Управление стадией жизненного цикла КЕ
Описание: Функция выполняет запрос к API [POST] /api/public/sm/v2/rsm/config-items/{id}/stages/category для перевода КЕ по жизненному циклу.
Inputs
| Название | Тип | Описание |
|---|---|---|
| In, BearerToken | Общие параметры для функций | |
| ConfigItemId | Integer64 | Идентификатор КЕ |
| Category | String | Название категории стадии жизненного цикла КЕ |
| ApplyGrants | Boolean | Если задано True – применить настройки доступа к подчиненным КЕ. По умолчанию: False. |
Outputs
| Название | Тип | Описание |
|---|---|---|
| Ok, Failed, Response | Общие параметры для функций | |
| Stage | Struct: Automaton.CMDB.Stage | Модель стадии жизненного цикла, на которой сейчас находится КЕ |
SetStageByCategoryBatch
Назначение: Пакетная установка категорий жизненного цикла КЕ
Описание: Функция выполняет запрос к API Monq для пакетного обновления информации о категории жизненного цикла КЕ.
Inputs
| Название | Тип | Описание |
|---|---|---|
| In, BearerToken | Общие параметры для функций | |
| StageCategoryPosts | Struct: StageCategoryPostBatch (array) | Модель запроса. Доступные категории ЖЦ: Active, Archive, Deleted |
Outputs
| Название | Тип | Описание |
|---|---|---|
| Ok, Failed, Response | Общие параметры для функций | |
| Stages | Struct: Stage (array) | Массив моделей стадий ЖЦ, на которой сейчас находятся КЕ |
Функции для работы с режимами обслуживания
GetMaintenances
Назначение: Получение всех режимов обслуживания
Описание: Функция выполняет запрос к API для получения доступных режимов обслуживания.
Inputs
| Название | Тип | Описание |
|---|---|---|
| In, BearerToken | Общие параметры для функций | |
| Paging | Struct: PagingModel | Модель постраничного запроса |
Outputs
| Название | Тип | Описание |
|---|---|---|
| Ok, Failed, Response | Общие параметры для функций | |
| Maintenances | Struct: Maintenance (array) | Список моделей режимов обслуживания |
GetMaintenanceById
Назначение: Получение режима обслуживания по его идентификатору
Описание: Функция выполняет запрос к API для получения режима обслуживания по его идентификатору.
Inputs
| Название | Тип | Описание |
|---|---|---|
| In, BearerToken | Общие параметры для функций | |
| MaintenanceId | Integer64 | Идентификатор режима обслуживания |
Outputs
| Название | Тип | Описание |
|---|---|---|
| Ok, Failed, Response | Общие параметры для функций | |
| Maintenance | Struct: Maintenance | Модель режима обслуживания |
FilterMaintenances
Назначение: Получение режимов обслуживания согласно заданного фильтра
Описание: Функция выполняет запрос к API для нахождения режимов обслуживания по указанным параметрам.
Inputs
| Название | Тип | Описание |
|---|---|---|
| In, BearerToken | Общие параметры для функций | |
| Paging | Struct: PagingModel | Модель постраничного запроса |
| Ids | Integer64 (array) | Список идентификаторов режимов обслуживания |
| DateStart | Struct: DatePost | Дата начала режима обслуживания |
| DateEnd | Struct: DatePost | Дата окончания режима обслуживания |
| СonfigItemIds | Integer64 (array) | Список идентификаторов связанных КЕ |
Outputs
| Название | Тип | Описание |
|---|---|---|
| Ok, Failed, Response | Общие параметры для функций | |
| Maintenance | Struct: Maintenance (array) | Список моделей режимов обслуживания |
CreateMaintenance
Назначение: Создание режима обслуживания
Описание: Функция выполняет запрос к API для создания режима обслуживания.
Inputs
| Название | Тип | Описание |
|---|---|---|
| In, BearerToken | Общие параметры для функций | |
| BatchValidate | Boolean | Выполняется проверка для всех КЕ на то, что они зарегистрированы в системе и доступны пользователю на установку сервисного режима |
| DateStart | Struct: DatePost | Дата начала режима обслуживания |
| DateEnd | Struct: DatePost | Дата окончания режима обслуживания |
| Title | String | Название режима обслуживания |
| ConfigItems | Struct: ConfigItemToMaintenancePost (array) | Список моделей связанных КЕ |
| Labels | Dynamic | Метки в формате ключ : значение |
Outputs
| Название | Тип | Описание |
|---|---|---|
| Ok, Failed, Response | Общие параметры для функций | |
| Maintenance | Struct: Maintenance | Модель созданного режима обслуживания |
Struct: ConfigItemToMaintenancePost
Описание структуры Struct: ConfigItemToMaintenancePost:
| Пин | Тип | Описание |
|---|---|---|
| Id | Integer64 | Идентификатор КЕ |
| Scope | Enum | Способ распространения режима обслуживания по графу |
| Depth | Integer64 | Глубина распространения по графу |
Допустимые значения:
ScopeCi- только текущая КЕCiAndChildren- текущая КЕ и все подчиненные ей КЕ на глубинуDepth
UpdateMaintenance
Назначение: Обновление режима обслуживания
Описание: Функция выполняет запрос к API для обновления параметров режима обслуживания по его идентификатору.
Inputs
| Название | Тип | Описание |
|---|---|---|
| In, BearerToken | Общие параметры для функций | |
| Id | Integer64 | Идентификатор режима обслуживания |
| BatchValidate | Boolean | Выполняется проверка для всех КЕ на то, что они зарегистрированы в системе и доступны пользователю на установку сервисного режима |
| DateStart | Struct: DatePost | Дата начала режима обслуживания |
| DateEnd | Struct: DatePost | Дата окончания режима обслуживания |
| Title | String | Название режима обслуживания |
| ConfigItems | Struct: ConfigItemToMaintenancePost (array) | Список моделей связанных КЕ |
| Labels | Dynamic | Метки в формате ключ : значение |
Outputs
| Название | Тип | Описание |
|---|---|---|
| Ok, Failed, Response | Общие параметры для функций | |
| Maintenance | Struct: Maintenance | Модель обновленного режима обслуживания |
PartialUpdateMaintenance
Назначение: Частичное обновление режима обслуживания
Описание: Функция выполняет запрос к API для частичного обновления параметров режима обслуживания по его идентификатору.
Inputs
| Название | Тип | Описание |
|---|---|---|
| In, BearerToken | Общие параметры для функций | |
| Id | Integer64 | Идентификатор режима обслуживания |
| BatchValidate | Boolean | Выполняется проверка для всех КЕ на то, что они зарегистрированы в системе и доступны пользователю на установку сервисного режима |
| DateStart | Struct: DatePost | Дата начала режима обслуживания |
| DateEnd | Struct: DatePost | Дата окончания режима обслуживания |
| Title | String | Название режима обслуживания |
| ConfigItems | Struct: ConfigItemToMaintenancePost (array) | Список моделей связанных КЕ |
| Labels | Dynamic | Метки в формате ключ : значение |
| Cancel | Boolean | Если True - режим обслуживания будет отменен, если запланирован или активен |
Outputs
| Название | Тип | Описание |
|---|---|---|
| Ok, Failed, Response | Общие параметры для функций | |
| Maintenance | Struct: Maintenance | Модель обновленного режима обслуживания |