Версия: 8.3

Функции для работы с РСМ

Описание и характеристика функций модуля Автоматизации, которые можно использовать при разработке сценариев автоматического построения РСМ.

Общие функции

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	Связь

CreateSubordinationLink

Назначение: Создать связь подчинения между КЕ

Описание: Функция выполняет запрос к API [POST] /api/public/sm/v2/rsm/config-items/{parentId}/children для установки связи подчинения между КЕ.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
ParentId	Integer64	Идентификатор родительской КЕ	Связь/контрол
ChildId	Integer64	Идентификатор подчиняемой КЕ	Связь/контрол

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
ConfigItem	Struct:Automaton.CMDB.ConfigItem	Модель подчиненной КЕ	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

CreateImpactLink

Назначение: Создать связь влияния между КЕ

Описание: Функция выполняет запрос к API [POST] /api/public/sm/v2/rsm/config-items/{parentId}/children для установки связи влияния между КЕ.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
DependentId	Integer64	Идентификатор зависимой КЕ	Связь/контрол
InfluentialId	Integer64	Идентификатор влияющей КЕ	Связь/контрол

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
ImpactConfigItems	Struct:Automaton.CMDB.ImpactLinkConfigitem (Array)	Обновлённый список моделей влияющих КЕ с минимальным набором атрибутов: идентификатор `id`, название `name` и словарь меток `labels`	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

DeleteSubordinationLink

Назначение: Удаление связи подчинения между КЕ

Описание: Функция выполняет запрос к API [DELETE] /api/public/sm/v2/rsm/config-items/{parentId}/children/{childId} для удаления связи подчинения между КЕ.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
ParentId	Integer64	Идентификатор родительской КЕ	Связь/контрол
ChildId	Integer64	Идентификатор подчиненной КЕ	Связь/контрол

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
ConfigItem	Struct:Automaton.CMDB.ConfigItem	Модель ранее подчиненной КЕ	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

DeleteImpactLink

Назначение: Удаление связи влияния между КЕ

Описание: Функция выполняет запрос к API [DELETE] /api/public/sm/v2/rsm/config-items/{dependentId}/influentials/{influentialId} для удаления связи влияния между КЕ.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
DependentId	Integer64	Идентификатор зависимой КЕ	Связь/контрол
InfluentialId	Integer64	Идентификатор влияющей КЕ	Связь/контрол

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
ImpactConfigItems	Struct:Automaton.CMDB.ImpactLinkConfigitem (Array)	Обновлённый список моделей влияющих КЕ с минимальным набором атрибутов: идентификатор `id`, название `name` и словарь меток `labels`	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

CreateLinksBatch

Назначение: Пакетная установка связей между КЕ

Описание: Функция выполняет запрос к API Monq для пакетной установки связи между КЕ.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
LinkPostModels	Struct:ConfigItemLinkPost (Array)	Модель запроса для установки связей	Связь

SourceId - идентификатор КЕ, от которой идет связь подчинения или влияния
TargetId - идентификатор КЕ, к которой идет связь подчинения и влияния
Доступные типы связей:
- Influence - связь влияния
- Hierarchy - связь подчинения
- Info - информационная связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
ConfigItemLinks	Struct:ConfigItemInfluenceLink (Array)	Массив моделей созданных связей	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

CreateInfluenceLinksBatch

Назначение: Пакетная установка связей влияния между КЕ

Описание: Функция выполняет запрос к API на массовое создание связей влияния, с указанием нужных параметров. В отличие от функций создания связей, здесь нет необходимости указывать тип создаваемых связей.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
InfluenceLinkPostModels	Struct:ConfigItemInfluenceLinkPost (Array)	Модель запроса для установки связей влияния	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
ConfigItemLinks	Struct:ConfigItemInfluenceLink (Array)	Массив моделей созданных связей	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

UpdateLinksBatch

Назначение: Пакетное обновление общей информации о связи любого типа

Описание: Функция выполняет запрос к API на массовое обновление общих параметров связи любого типа. Обновляются все общие параметры связи любого типа.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
LinkPutModels	Struct:ConfigItemLinkPut (Array)	Модель запроса для обновления связей любого типа	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
ConfigItemLinks	Struct:ConfigItemLinkPostResult (Array)	Массив моделей обновленных связей	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

PartialUpdateLinksBatch

Назначение: Пакетное обновление (частичное) общей информации о связи любого типа

Описание: Функция выполняет запрос к API на массовое, частичное, обновление общих параметров связи любого типа. Обновляются только те значения параметров связей, которые переданы на вход.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
LinkPatchModels	Struct:ConfigItemLinkPatch (Array)	Модель запроса для обновления связей любого типа	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
ConfigItemLinks	Struct:ConfigItemLinkPostResult (Array)	Массив моделей обновленных связей	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

DeleteLinksBatch

Назначение: Пакетное удаление связей между КЕ

Описание: Функция выполняет запрос к API Monq для пакетного удаления связей между КЕ.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
LinkDeleteModels	Struct:ConfigItemLinkDelete (Array)	Модель запроса для удаления связей	Связь

SourceId - идентификатор КЕ, от которой идет связь подчинения или влияния
TargetId - идентификатор КЕ, к которой идет связь подчинения и влияния
Доступные типы связей для удаления:
- Influence - связь влияния
- Hierarchy - связь подчинения

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
ConfigItemLinks	Struct:ConfigItemInfluenceLink (Array)	Массив моделей созданных связей	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

Функции управления доступом

подсказка

Для использования функций предоставления доступа к КЕ потребуется указать BearerToken пользователя, у которого:

Есть доступ на редактирование КЕ, к которой нужно предоставить доступ
Есть доступ к РГ, которой планируется предоставить доступ, с любой ролью

GrantAccessToConfigItem

Назначение: Предоставление доступа к КЕ

Описание: Функция выполняет запрос к API [POST] /api/public/sm/v2/rsm/config-items/{id}/work-groups для предоставления доступа к КЕ рабочей группе.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
ConfigItemId	Integer64	Идентификатор обновляемой КЕ	Связь/контрол
WorkGroupGrant	Struct:Automaton.CMDB.WorkGroupGrantModel	Модель запроса	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
ConfigItem	Struct:Automaton.CMDB.ConfigItem	Модель обновленной КЕ	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

GrantAccessToConfigItemExpanded

Назначение: Предоставление доступа к КЕ (Expanded)

Описание: Функция аналогична функции GrantAccessToConfigItem за исключением входящих в нее пинов.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
ConfigItemId	Integer64	Идентификатор обновляемой КЕ	Связь/контрол
WorkGroupId	Integer64	Идентификатор рабочей группы, которой предоставляется доступ к КЕ	Связь/контрол
ShareType	String	Тип предоставляемых прав	Связь/контрол
Grants	String (Array)	Предоставляемые рабочим группам права	Связь

Справка

Тип предоставляемых прав

Тип	Описание
`ConfigItem`	Предоставить права доступа только для КЕ
`Tree`	Предоставить права доступа для КЕ и подчинённого ей дерева
`ChildrenTree`	Предоставить права доступа только для подчинённого данной КЕ дерева

Предоставляемые рабочим группам права

Тип	Описание
`read`	Право на полное чтение КЕ
`write`	Право на полное управление КЕ

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
ConfigItem	Struct:Automaton.CMDB.ConfigItem	Модель обновленной КЕ	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

UpdateAccessToConfigItem

Назначение: Обновление предоставленного доступа к КЕ

Описание: Функция выполняет запрос к API [PUT] /api/public/sm/v2/rsm/config-items/{id}/work-groups для обновления предоставленного доступа к КЕ.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
ConfigItemId	Integer64	Идентификатор обновляемой КЕ	Связь/контрол
WorkGroupGrant	Struct:Automaton.CMDB.WorkGroupGrantModel	Модель запроса	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
ConfigItem	Struct:Automaton.CMDB.ConfigItem	Модель обновленной КЕ	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

UpdateAccessToConfigItemExpanded

Назначение: Обновление предоставленного доступа к КЕ (Expanded)

Описание: Функция аналогична функции UpdateAccessToConfigItem за исключением входящих в нее пинов.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
ConfigItemId	Integer64	Идентификатор обновляемой КЕ	Связь/контрол
WorkGroupId	Integer64	Идентификатор рабочей группы, которой предоставляется доступ к КЕ	Связь/контрол
ShareType	String	Тип предоставляемых прав	Связь/контрол
Grants	String (Array)	Предоставляемые рабочим группам права	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
ConfigItem	Struct:Automaton.CMDB.ConfigItem	Модель обновленной КЕ	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

DeleteAccessToConfigItem

Назначение: Удаление предоставленного доступа к КЕ

Описание: Функция выполняет запрос к API [DELETE] /api/public/sm/v2/rsm/config-items/{id}/work-groups/{sharedId} для удаления предоставленного доступа к КЕ.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
ConfigItemId	Integer64	Идентификатор обновляемой КЕ	Связь/контрол
SharedWorkGroupId	Integer64	Идентификатор модели предоставления доступа к КЕ	Связь/контрол

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
ConfigItem	Struct:Automaton.CMDB.ConfigItem	Модель обновленной КЕ	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

Функции управления жизненным циклом КЕ

SetStageById

Назначение: Управление стадией жизненного цикла КЕ

Описание: Функция выполняет запрос к API [POST] /api/public/sm/v2/rsm/config-items/{id}/stages для перевода КЕ по жизненному циклу.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
ConfigItemId	Integer64	Идентификатор зависимой КЕ	Связь/контрол
StageId	Integer64	Идентификатор стадии жизненного цикла	Связь/контрол
ApplyGrants	Boolean	Если задано `True` – применить настройки доступа к подчинённым КЕ. По умолчанию – `False`.	Связь/контрол

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Stage	Struct:Automaton.CMDB.Stage	Модель стадии жизненного цикла, на которой сейчас находится КЕ	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

SetStageByCategory

Назначение: Управление стадией жизненного цикла КЕ

Описание: Функция выполняет запрос к API [POST] /api/public/sm/v2/rsm/config-items/{id}/stages/category для перевода КЕ по жизненному циклу.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
ConfigItemId	Integer64	Идентификатор зависимой КЕ	Связь/контрол
Category	String	Название категории стадии жизненного цикла КЕ	Связь/контрол
ApplyGrants	Boolean	Если задано `True` – применить настройки доступа к подчинённым КЕ. По умолчанию – `False`.	Связь/контрол

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Stage	Struct:Automaton.CMDB.Stage	Модель стадии жизненного цикла, на которой сейчас находится КЕ	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

SetStageByCategoryBatch

Назначение: Пакетная установка категорий жизненного цикла КЕ

Описание: Функция выполняет запрос к API Monq для пакетного обновления информации о категории жизненного цикла КЕ.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
StageCategoryPosts	Struct:StageCategoryPostBatch (Array)	Модель запроса. Доступные категории ЖЦ: `Active`, `Archive`, `Deleted`	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Stages	Struct:Stage (Array)	Массив моделей стадий ЖЦ, на которой сейчас находятся КЕ	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

Функции для работы с атрибутами КЕ

FilterAttributesConfigItem

Назначение: Получение атрибутов КЕ по фильтру

Описание: Функция выполняет запрос к API [POST] /api/public/sm/v2/rsm/config-items/attributes/filter для получения атрибутов КЕ по фильтру.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
AttributeFilter	Struct:Automaton.CMDB.AttributeFilter	Модель фильтра атрибутов	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Attributes	Struct:Automaton.CMDB.Attributes (Array)	Список моделей атрибутов КЕ	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

FilterAttributesConfigItemExpanded

Назначение: Получение атрибутов КЕ по фильтру (Expanded)

Описание: Функция аналогична функции FilterAttributesConfigItem за исключением входящих в нее пинов.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
ConfigItemIds	Integer64 (Array)	Список идентификаторов КЕ	Связь/контрол
KeyValues	Struct:Automaton.CMDB.AttributeFilterKeyValue (Array)	Список моделей атрибутов КЕ	Связь/контрол

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Attributes	Struct:Automaton.CMDB.Attributes (Array)	Список моделей атрибутов КЕ	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

CreateAttribute

Назначение: Создание атрибута КЕ

Описание: Функция выполняет запрос к API [POST] /api/public/sm/v2/rsm/config-items/{id}/attributes для создания нового атрибута КЕ.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
AttributeRequest	Struct:Automaton.CMDB.AttributeRequest	Модель объекта атрибута	Связь
ConfigItemId	Integer64	Идентификатор КЕ	Связь/контрол

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Attribute	Struct:Automaton.CMDB.Attribute	Модель атрибута КЕ	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

CreateAttributeExpanded

Назначение: Создание атрибута КЕ (Expanded)

Описание: Функция аналогична функции CreateAttribute за исключением входящих в нее пинов.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
ConfigItemId	Integer64	Идентификатор КЕ	Связь/контрол
Key	String	Ключ атрибута КЕ	Связь/контрол
Value	Dynamic	Значение атрибута КЕ	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Attribute	Struct:Automaton.CMDB.Attribute	Модель атрибута КЕ	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

UpdateAttribute

Назначение: Обновление атрибута КЕ

Описание: Функция выполняет запрос к API [PUT] /api/public/sm/v2/rsm/config-items/{id}/attributes для обновления существующего атрибута КЕ.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
AttributeRequest	Struct:Automaton.CMDB.AttributeRequest	Обновленная модель атрибута КЕ	Связь/контрол
ConfigItemId	Integer64	Идентификатор КЕ	Связь/контрол

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
UpdatedAttribute	Struct:Automaton.CMDB.Attribute	Обновленная модель атрибута КЕ	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

UpdateConfigItemAttributesBatch

Назначение: Массовое обновление атрибутов КЕ

Описание: Функция выполняет запрос к API [PUT] /api/public/sm/v2/rsm/config-items/attributes/batch для массового обновления пространственных и типовых атрибутов КЕ.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
AttributePutModels	Struct:Automaton.CMDB.AttributePutBatch (Array)	Модель атрибута КЕ (идентификатор КЕ, ключ и значение атрибута)	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Attributes	Struct:Automaton.CMDB.Attributes	Массив полных моделей Атрибутов КЕ	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

UpdateAttributeExpanded

Назначение: Создание атрибута КЕ (Expanded)

Описание: Функция аналогична функции UpdateAttribute за исключением входящих в нее пинов.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
ConfigItemId	Integer64	Идентификатор КЕ	Связь/контрол
Key	String	Ключ атрибута КЕ	Связь/контрол
Value	Dynamic	Значение атрибута КЕ	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
UpdatedAttribute	Struct:Automaton.CMDB.Attribute	Обновленная модель атрибута КЕ	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

Функции для работы с компонентами КЕ

Модель компонента КЕ содержит следующую информацию:

Id- идентификатор компонента
Name - название компонента
IsDefault - является ли компонентом по умолчанию
SignalHealth - параметры для расчёта здоровья по сигналу
EdgeHealth - параметры расчёта здоровья по связи влияния
ConfigItemHealth - параметры расчёта здоровья на КЕ
ComboHealth - параметры расчёта здоровья через комбо-влияние
ConfigItemId - идентификатор КЕ

UpdateConfigItemComponent

Назначение: Обновление параметров влияния компонента на здоровье КЕ

Описание: Функция выполняет запрос к API на обновление всех параметров влияния компонента на здоровье КЕ.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
ConfigItemComponentPutModel	Struct:ConfigItemComponentPut	Модель запроса для обновления параметров компонента КЕ	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Component	Struct:ConfigItemComponent	Модель обновленного компонента	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

PartialUpdateConfigItemComponent

Назначение: Частичное обновление параметров влияния компонента на здоровье КЕ

Описание: Функция выполняет запрос к API на частично обновление параметров влияния компонента на здоровье КЕ. Обновляются только те значения параметров компонента, которые переданы на вход.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
ConfigItemComponentPatchModel	Struct:ConfigItemComponentPatch	Модель запроса для обновления параметров компонента КЕ	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Component	Struct:ConfigItemComponent	Модель обновленного компонента	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

UpdateConfigItemComponentsBatch

Назначение: Массовое обновление всех параметров влияния компонента на здоровье КЕ

Описание: Функция выполняет запрос к API на массовое обновление всех параметров влияния компонента на здоровье КЕ. Обновляются все параметры компонента, которые оказывают влияние на здоровье КЕ.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
ConfigItemComponentPutModels	Struct:ConfigItemComponentPutModels (array)	Список моделей для обновления параметров компонента КЕ	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Components	Struct:ConfigItemComponent (array)	Список моделей обновленного компонента	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

PartialUpdateConfigItemComponentsBatch

Назначение: Массовое (частичное) обновление всех параметров влияния компонента на здоровье КЕ

Описание: Функция выполняет запрос к API на частичное массовое обновление параметров влияния компонента на здоровье КЕ. Обновляются только те значения параметров компонентов, которые переданы на вход.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
ConfigItemComponentPatchModels	Struct:ConfigItemComponentPatchModels (array)	Список моделей для обновления параметров компонента КЕ	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Components	Struct:ConfigItemComponent (array)	Список моделей обновленного компонента	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

FilterConfigItemComponents

Назначение: Функция фильтрации по компонентам КЕ

Описание: Функция выполняет запрос к API для получения информации о компоненте КЕ

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
Ids	Integer64 (array)	Идентификаторы компонентов, полную информацию о которых нужно получить в ответе	Связь
Names	String (array)	Названия компонентов, полную информацию о которых нужно получить в ответе	Связь
ConfigItemIds	Integer64 (array)	Идентификаторы КЕ, информацию о компонентах которой нужно получить в ответе	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Components	Struct:ConfigItemComponent (array)	Список моделей полученных компонентов	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

Функции для работы с режимами обслуживания

GetMaintenances

Назначение: Получение всех режимов обслуживания

Описание: Функция выполняет запрос к API для получения доступных режимов обслуживания.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
Paging	Struct:PagingModel	Модель постраничного запроса	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Maintenances	Struct:Maintenance (array)	Список моделей режимов обслуживания	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

GetMaintenanceById

Назначение: Получение режима обслуживания по его идентификатору

Описание: Функция выполняет запрос к API для получения режима обслуживания по его идентификатору.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
MaintenanceId	Integer64	Идентификатор режима обслуживания	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Maintenance	Struct:Maintenance	Модель режима обслуживания	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

FilterMaintenances

Назначение: Получение режимов обслуживания согласно заданного фильтра

Описание: Функция выполняет запрос к API для нахождения режимов обслуживания по указанным параметрам.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
Paging	Struct:PagingModel	Модель постраничного запроса	Связь
Ids	Integer64 (array)	Список идентификаторов режимов обслуживания	Связь
DateStart	Struct:DatePost	Дата начала режима обслуживания	Связь
DateEnd	Struct:DatePost	Дата окончания режима обслуживания	Связь
СonfigItemIds	Integer64 (array)	Список идентификаторов связанных КЕ	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Maintenance	Struct:Maintenance (array)	Список моделей режимов обслуживания	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

CreateMaintenance

Назначение: Создание режима обслуживания

Описание: Функция выполняет запрос к API для создания режима обслуживания.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
BatchValidate	Boolean	Выполняется проверка для всех КЕ на то, что они зарегистрированы в системе и доступны пользователю на установку сервисного режима	Связь
DateStart	Struct:DatePost	Дата начала режима обслуживания	Связь
DateEnd	Struct:DatePost	Дата окончания режима обслуживания	Связь
Title	String	Название режима обслуживания	Связь
ConfigItems	Struct:ConfigItemToMaintenancePost (array)	Список моделей связанных КЕ	Связь
Labels	Dynamic	Метки в формате ключ : значение	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Maintenance	Struct:Maintenance	Модель созданного режима обслуживания	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

Struct:ConfigItemToMaintenancePost

Описание структуры Struct:ConfigItemToMaintenancePost:

Пин	Тип	Описание
Id	Integer64	Идентификатор КЕ
Scope	Enum	Способ распространения режима обслуживания по графу
Depth	Integer64	Глубина распространения по графу

Допустимые значения:

Scope
- Ci - только текущая КЕ
- CiAndChildren - текущая КЕ и все подчиненные ей КЕ на глубину Depth

UpdateMaintenance

Назначение: Обновление режима обслуживания

Описание: Функция выполняет запрос к API для обновления параметров режима обслуживания по его идентификатору.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
Id	Integer64	Идентификатор режима обслуживания	Связь/контрол
BatchValidate	Boolean	Выполняется проверка для всех КЕ на то, что они зарегистрированы в системе и доступны пользователю на установку сервисного режима	Связь
DateStart	Struct:DatePost	Дата начала режима обслуживания	Связь
DateEnd	Struct:DatePost	Дата окончания режима обслуживания	Связь
Title	String	Название режима обслуживания	Связь
ConfigItems	Struct:ConfigItemToMaintenancePost (array)	Список моделей связанных КЕ	Связь
Labels	Dynamic	Метки в формате ключ : значение	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Maintenance	Struct:Maintenance	Модель обновленного режима обслуживания	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

PartialUpdateMaintenance

Назначение: Частичное обновление режима обслуживания

Описание: Функция выполняет запрос к API для частичного обновления параметров режима обслуживания по его идентификатору.

Inputs

Название	Тип	Описание	Параметры
In	Exec	Пин вызова	Связь
BearerToken	String	По умолчанию `BearerToken` запрашивается из переменной `Scenario`, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
Id	Integer64	Идентификатор режима обслуживания	Связь/контрол
BatchValidate	Boolean	Выполняется проверка для всех КЕ на то, что они зарегистрированы в системе и доступны пользователю на установку сервисного режима	Связь
DateStart	Struct:DatePost	Дата начала режима обслуживания	Связь
DateEnd	Struct:DatePost	Дата окончания режима обслуживания	Связь
Title	String	Название режима обслуживания	Связь
ConfigItems	Struct:ConfigItemToMaintenancePost (array)	Список моделей связанных КЕ	Связь
Labels	Dynamic	Метки в формате ключ : значение	Связь
Cancel	Boolean	Если `True` - режим обслуживания будет отменён, если запланирован или завершен, если активен	Связь

Outputs

Название	Тип	Описание	Параметры
Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
Maintenance	Struct:Maintenance	Модель обновленного режима обслуживания	Связь
Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

Общие функции​

GetConfigItemTypes​

GetWorkGroups​

Функции поиска КЕ​

GetConfigItemByUniqueKey​

GetAllConfigItems​

FilterConfigItems​

FilterConfigItemsExpanded​

FilterConfigItemsExtended​

GetConfigItem​

GetConfigItemsBatch​

Функции создания КЕ​

CreateConfigItem​

CreateConfigItemExpanded​

CreateConfigItemsBatch​

Функции удаления КЕ​

DeleteConfigItem​

DeleteConfigItemsBatch​

Функции обновления КЕ​

UpdateConfigItem​

UpdateConfigItemExpanded​

UpdateConfigItemsBatch​

Функции управления связями КЕ​

UpdateInfluenceLinksBatch​

PartialUpdateInfluenceLinksBatch​

CreateSubordinationLink​

CreateImpactLink​

DeleteSubordinationLink​

DeleteImpactLink​

CreateLinksBatch​

CreateInfluenceLinksBatch​

UpdateLinksBatch​

PartialUpdateLinksBatch​

DeleteLinksBatch​

Функции управления доступом​

GrantAccessToConfigItem​

GrantAccessToConfigItemExpanded​

Тип предоставляемых прав​

Предоставляемые рабочим группам права​

UpdateAccessToConfigItem​

UpdateAccessToConfigItemExpanded​

DeleteAccessToConfigItem​

Функции управления жизненным циклом КЕ​

SetStageById​

SetStageByCategory​

SetStageByCategoryBatch​

Функции для работы с атрибутами КЕ​

FilterAttributesConfigItem​

FilterAttributesConfigItemExpanded​

CreateAttribute​

CreateAttributeExpanded​

UpdateAttribute​

UpdateConfigItemAttributesBatch​

UpdateAttributeExpanded​

Функции для работы с компонентами КЕ​

UpdateConfigItemComponent​

PartialUpdateConfigItemComponent​

UpdateConfigItemComponentsBatch​

PartialUpdateConfigItemComponentsBatch​

FilterConfigItemComponents​

Функции для работы с режимами обслуживания​

GetMaintenances​

GetMaintenanceById​

FilterMaintenances​

CreateMaintenance​

Struct:ConfigItemToMaintenancePost​

UpdateMaintenance​

PartialUpdateMaintenance​

Общие функции

GetConfigItemTypes

GetWorkGroups

Функции поиска КЕ

GetConfigItemByUniqueKey

GetAllConfigItems

FilterConfigItems

FilterConfigItemsExpanded

FilterConfigItemsExtended

GetConfigItem

GetConfigItemsBatch

Функции создания КЕ

CreateConfigItem

CreateConfigItemExpanded

CreateConfigItemsBatch

Функции удаления КЕ

DeleteConfigItem

DeleteConfigItemsBatch

Функции обновления КЕ

UpdateConfigItem

UpdateConfigItemExpanded

UpdateConfigItemsBatch

Функции управления связями КЕ

UpdateInfluenceLinksBatch

PartialUpdateInfluenceLinksBatch

CreateSubordinationLink

CreateImpactLink

DeleteSubordinationLink

DeleteImpactLink

CreateLinksBatch

CreateInfluenceLinksBatch

UpdateLinksBatch

PartialUpdateLinksBatch

DeleteLinksBatch

Функции управления доступом

GrantAccessToConfigItem

GrantAccessToConfigItemExpanded

Тип предоставляемых прав

Предоставляемые рабочим группам права

UpdateAccessToConfigItem

UpdateAccessToConfigItemExpanded

DeleteAccessToConfigItem

Функции управления жизненным циклом КЕ

SetStageById

SetStageByCategory

SetStageByCategoryBatch

Функции для работы с атрибутами КЕ

FilterAttributesConfigItem

FilterAttributesConfigItemExpanded

CreateAttribute

CreateAttributeExpanded

UpdateAttribute

UpdateConfigItemAttributesBatch

UpdateAttributeExpanded

Функции для работы с компонентами КЕ

UpdateConfigItemComponent

PartialUpdateConfigItemComponent

UpdateConfigItemComponentsBatch

PartialUpdateConfigItemComponentsBatch

FilterConfigItemComponents

Функции для работы с режимами обслуживания

GetMaintenances

GetMaintenanceById

FilterMaintenances

CreateMaintenance

Struct:ConfigItemToMaintenancePost

UpdateMaintenance

PartialUpdateMaintenance