Функции для работы с РСМ
Описание и характеристика функций модуля Автоматизации, которые можно использовать при разработке сценариев автоматического построения РСМ.
Общие функции
GetConfigItemTypes
-
Назначение: Получение доступных типов КЕ
-
Описание: Функция выполняет запрос к API
[GET] /api/public/sm/v2/rsm/config-item-types
и возвращает список доступных типов конфигурационных единиц.-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь ConfigItemTypes Struct:Automaton.CMDB.ConfigItemType (Array) Возвращает список моделей типов КЕ Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
GetWorkGroups
-
Назначение: Получение доступных рабочих групп
-
Описание: Функция выполняет запрос к API
[GET] /api/public/sm/v2/rsm/work-groups
и возвращает список доступных рабочих групп.-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь WorkGroups Struct:Automaton.CMDB.WorkGroup (Array) Возвращает список моделей доступных рабочих групп Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
Функции поиска КЕ
GetConfigItemByUniqueKey
-
Назначение: Получение КЕ по уникальному ключу из кэша
-
Описание: Функция выполняет запрос к API
[POST] /api/public/sm/v2/rsm/config-items/attributes/unique-keys
и возвращает упрощенную модель КЕ.-
Определение ключевых параметров для формирования уникального ключа определяется пользователем в настройках типа КЕ. Подробнее - Управление атрибутами типа КЕ
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол ConfigItemTypeId Integer64 Идентификатор типа КЕ Связь/контрол Attributes Dynamic Ключевые параметры атрибутов Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь ConfigItem Struct:Automaton.CMDB.ConfigItemByUniqueKey (Single) Упрощенная модель КЕ (ID и стадия ЖЦ) Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
GetAllConfigItems
-
Назначение: Получение всех доступных КЕ
-
Описание: Функция выполняет запрос к API
[GET] /api/public/sm/v2/rsm/config-items
и возвращает список доступных конфигурационных единиц.-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь WorkGroups Struct:Automaton.CMDB.ConfigItemShort (Array) Возвращает список моделей доступных конфигурационных единиц Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
FilterConfigItems
-
Назначение: Получение доступных КЕ по фильтру
-
Описание: Функция выполняет запрос к API
[POST] /api/public/sm/v2/rsm/config-items/filter
и возвращает список доступных конфигурационных единиц согласно условиям фильтра.-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол Filter Struct:Automaton.CMDB.ConfigItemFilter Модель фильтра Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Configitems Struct:Automaton.CMDB.ConfigItemFilterResult (Array) Возвращает список моделей доступных конфигурационных единиц согласно фильтра Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
FilterConfigItemsExpanded
-
Назначение: Получение доступных КЕ по фильтру (Expanded)
-
Описание: Функция аналогична функции FilterConfigItems за исключением входящих в нее пинов.
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол Ids Integer64 (Array) Идентификатор КЕ Связь Names String (Array) Название КЕ Связь Labels Dynamic Метки КЕ Связь StageCategories String (Array) Стадии жизненного цикла КЕ Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь ConfigItems Struct:Automaton.CMDB.ConfigItemFilterResult (Array) Возвращает список моделей доступных конфигурационных единиц согласно фильтра Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
FilterConfigItemsExtended
-
Назначение: Получение доступных КЕ по фильтру (Extended)
-
Описание:
-
Особенностью данной функции является наличие нескольких дополнительных параметров для создании более точных запросов фильтрации
-
Возможность указать маску полей (fieldMask)
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол Paging PagingModel Модель постраничного запроса, с возможностью указать дополнительные параметры фильтрации Связь FieldMask String Маска возвращаемых полей Связь Ids Integer64 (Array) Идентификаторы КЕ Связь Names String (Array) Название КЕ Связь TypeIds Integer64 (Array) Тип КЕ Связь StageCategories String (Array) Стадии жизненного цикла КЕ Связь Labels Dynamic Метки КЕ Связь Attributes Dynamic Атрибуты КЕ Связь OwnerWorkGroups Integer64 (Array) Владелец КЕ Связь FieldMaskПредставляет собой строку с названиями полей из расширенной модели КЕ, разделённые через запятую (например,
id,name,ownerWorkGroup
).Если поле
FieldMask
не заполнено - будет возвращена полная модель КЕ, со всеми значениями полей. Данный параметр позволяет облегчить запрос к API путем указания только нужных полей в ответе. -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь ConfigItems Struct:ConfigItemExtended (Array) Возвращает список моделей полученных конфигурационных единиц по фильтру Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
GetConfigItem
-
Назначение: Получение информации о КЕ
-
Описание: Функция выполняет запрос к API
[GET] /api/public/sm/v2/rsm/config-items/{id}?includeState=false&includeHealth=false
для получения информации о КЕ.-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол Id Integer64 Идентификатор КЕ Связь/контрол IncludeState Boolean Если задано True
– включить информацию по статусу КЕ. По умолчанию –False
Связь/контрол IncludeHealth Boolean Если задано True
– включить информацию по здоровью КЕ. По умолчанию –False
Связь/контрол -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь ConfigItem Struct:Automaton.CMDB.ConfigItem Модель обновленной КЕ Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
GetConfigItemsBatch
-
Назначение: Пакетное получение информации по нескольким КЕ
-
Описание: Функция выполняет запрос к API Monq для пакетного получения полной информации о КЕ.
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол Ids Integer64 (Array) Список идентификаторов КЕ, по которым будет возвращена информация Связь IncludeState Boolean Параметр определяет, возвращать ли информацию по стадии ЖЦ в модели КЕ или нет Связь/контрол IncludeHealth Boolean Параметр определяет, возвращать ли информацию по здоровью в модели КЕ или нет Связь/контрол -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь ConfigItems Struct:Automaton.CMDB.ConfigItem (Array) Массив моделей созданных КЕ Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
Функции создания КЕ
CreateConfigItem
-
Назначение: Создание КЕ
-
Описание: Функция выполняет запрос к API
[POST] /api/public/sm/v2/rsm/config-items?makeNameUnique=false
для создания конфигурационной единицы.-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол ConfigItem Struct:Automaton.CMDB.ConfigItemPost Модель создаваемой КЕ Связь MakeNameIsUnique Boolean Признак уникальности названия конфигурационной единицы. Если True
- КЕ будет создана с добавлением индекса к названию, если КЕ с таким названием уже существует. ЕслиFalse
и КЕ уже существует будет возвращена ошибка400
и КЕ создана не будетСвязь/контрол -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь ConfigItems Struct:Automaton.CMDB.ConfigItem Возвращает модель созданной КЕ Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
CreateConfigItemExpanded
-
Назначение: Создание КЕ (Expanded)
-
Описание: Функция аналогична функции CreateConfigItem за исключением входящих в нее пинов.
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол Name String Название КЕ Связь/контрол Description String Описание КЕ Связь/контрол ParentId Integer64 Идентификатор родительской КЕ Связь/контрол ConfigItemTypeId Integer64 Идентификатор типа КЕ Связь/контрол OwnerWorkGroupId Integer64 Идентификатор РГ владельца КЕ Связь/контрол Labels Dynamic Метки КЕ Связь/контрол SharedToWorkGroups Struct:Automaton.CMDB:WorkGroupGrantModel Предоставление доступа к КЕ другим Рабочим группам Связь/контрол MakeNameIsUnique Boolean Признак уникальности названия конфигурационной единицы. Если True
- КЕ будет создана с добавлением индекса к названию, если КЕ с таким названием уже существует. ЕслиFalse
и КЕ уже существует будет возвращена ошибка400
и КЕ создана не будетСвязь/контрол -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь ConfigItem Struct:Automaton.CMDB.ConfigItem Возвращает модель созданной КЕ Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
CreateConfigItemsBatch
-
Назначение: Массовое создание КЕ
-
Описание: Функция выполняет запрос к API Monq для пакетного создания КЕ.
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол ConfigItemPosts Struct:Automaton.CMDB.ConfigItemPost (Array) Массив объектов КЕ Связь MakeNameIsUnique Boolean Признак уникальности названия конфигурационной единицы Связь/контрол -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Configitems Struct:Automaton.CMDB.ConfigItemShort (Array) Массив моделей созданных КЕ Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
Функции удаления КЕ
DeleteConfigItem
-
Назначение: Удаление КЕ
-
Описание: Функция выполняет запрос к API
[DELETE] /api/public/sm/v2/rsm/config-items/{id}?applyGrants=false
для полного удаления конфигурационной единицы.-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол ConfigItemId Integer64 Идентификатор удаляемой КЕ Связь ApplyGrants Boolean Если задано True
– применить настройки доступа удаляемой КЕ к подчинённым КЕСвязь/контрол -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
DeleteConfigItemsBatch
-
Назначение: Массовое удаление КЕ
-
Описание: Функция выполняет запрос к API для массового, полного удаления конфигурационных единиц.
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь ConfigItemIds Integer64 (array) Список идентификаторов удаляемых КЕ Связь ApplyGrants Boolean Если задано True
– применить настройки доступа удаляемой КЕ к подчинён ным КЕСвязь/контрол -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
Функции обновления КЕ
UpdateConfigItem
-
Назначение: Изменение основной информации о КЕ
-
Описание: Функция выполняет запрос к API
[PUT] /api/public/sm/v2/rsm/config-items/{id}?makeNameUnique=false
для обновления информации о КЕ.-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол ConfigItemId Integer64 Идентификатор обновляемой КЕ Связь/контрол ConfigItemPut Struct:Automaton.CMDB.ConfigItemPut Модель обновленной КЕ Связь MakeNameIsUnique Boolean Признак уникальности названия конфигурационной единицы. Связь/контрол -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь UpdatedConfigItem Struct:Automaton.CMDB.ConfigItem Модель обновленной КЕ Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
UpdateConfigItemExpanded
-
Назначение: Изменение основной информации о КЕ
-
Описание: Функция аналогична функции UpdateConfigItem за исключением входящих в нее пинов.
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол ConfigItemId Integer64 Идентификатор обновляемой КЕ Связь/контрол Name String Название КЕ Связь/контрол Description String Описание КЕ Связь/контрол ParentId Integer64 Идентификатор родительской КЕ Связь/контрол ConfigItemTypeId Integer64 Идентификатор типа КЕ Связь/контрол OwnerWorkGroupId Integer64 Идентификатор РГ владельца КЕ Связь/контрол Labels Dynamic Метки КЕ Связь/контрол MakeNameIsUnique Boolean Признак уникальности названия конфигураци онной единицы. Если True
- КЕ будет создана с добавлением индекса к названию, если КЕ с таким названием уже существует. ЕслиFalse
и КЕ уже существует будет возвращена ошибка400
и КЕ создана не будетСвязь/контрол -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь UpdatedConfigItem Struct:Automaton.CMDB.ConfigItem Модель обновленной КЕ Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
UpdateConfigItemsBatch
-
Назначение: Пакетное обновление информации о КЕ
-
Описание: Функция выполняет запрос к API Monq для пакетного обновления информации о КЕ.
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол ConfigItemsPatch Struct:ConfigItemPatchBatch (Array) Неполная модель КЕ, включает в себя обновление меток, типа КЕ и названия Связь MakeNamesIsUnique Boolean Признак уникальности названия КЕ.
True
- к названию КЕ будет добавлен постфикс
False
- КЕ не будет переименованаСвязь/контрол -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь UpdatedConfigItems Struct:ConfigItemShort (Array) Массив неполных моделей обновленных КЕ Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
Функции управления связями КЕ
UpdateInfluenceLinksBatch
-
Назначение: Массовое обновление связей влияния
-
Описание: Функция выполняет запрос к API на массовое обновление параметров связей влияния. Обновляются все параметры связей влияния.
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол InfluenceLinkPutModels Struct:ConfigItemInfluenceLinkPut Модель связи влияния (Id исходной КЕ, Id целевой КЕ, Тип связи, Метки, Название компонента, Параметры здоровья) Связь/контрол -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь InfluenceLinks Struct:ConfigItemInfluenceLink (array) Список моделей обновленных связей влияния Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-
PartialUpdateInfluenceLinksBatch
-
Назначение: Массовое (частичное) обновление связей влияния
-
Описание: Функция выполняет запрос к API на массовое обновление параметров связей влияния. Обновляются только те значения параметров связей влияния, которые переданы на вход.
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол InfluenceLinkPatchModels Struct:ConfigItemInfluenceLinkPatch Модель связи влияния (Id исходной КЕ, Id целевой КЕ, Тип связи, Метки, Название компонента, Параметры здоровья) Связь/контрол -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь InfluenceLinks Struct:ConfigItemInfluenceLink (array) Список моделей обновленных связей влияния Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
-