Перейти к основному содержимому
Версия: 8.1

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

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

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

GetConfigItemTypes

  • Назначение: Получение доступных типов КЕ

  • Описание: Функция выполняет запрос к API [GET] /api/public/sm/v2/rsm/config-item-types и возвращает список доступных типов конфигурационных единиц.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ConfigItemTypesStruct:Automaton.CMDB.ConfigItemType (Array)Возвращает список моделей типов КЕСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

GetWorkGroups

  • Назначение: Получение доступных рабочих групп

  • Описание: Функция выполняет запрос к API [GET] /api/public/sm/v2/rsm/work-groups и возвращает список доступных рабочих групп.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      WorkGroupsStruct:Automaton.CMDB.WorkGroup (Array)Возвращает список моделей доступных рабочих группСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

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

GetConfigItemByUniqueKey

  • Назначение: Получение КЕ по уникальному ключу из кэша

  • Описание: Функция выполняет запрос к API [POST] /api/public/sm/v2/rsm/config-items/attributes/unique-keys и возвращает упрощенную модель КЕ.

    • Определение ключевых параметров для формирования уникального ключа определяется пользователем в настройках типа КЕ. Подробнее - Управление атрибутами типа КЕ

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ConfigItemTypeIdInteger64Идентификатор типа КЕСвязь/контрол
      AttributesDynamicКлючевые параметры атрибутовСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ConfigItemStruct:Automaton.CMDB.ConfigItemByUniqueKey (Single)Упрощенная модель КЕ (ID и стадия ЖЦ)Связь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

GetAllConfigItems

  • Назначение: Получение всех доступных КЕ

  • Описание: Функция выполняет запрос к API [GET] /api/public/sm/v2/rsm/config-items и возвращает список доступных конфигурационных единиц.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      WorkGroupsStruct:Automaton.CMDB.ConfigItemShort (Array)Возвращает список моделей доступных конфигурационных единицСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

FilterConfigItems

  • Назначение: Получение доступных КЕ по фильтру

  • Описание: Функция выполняет запрос к API [POST] /api/public/sm/v2/rsm/config-items/filter и возвращает список доступных конфигурационных единиц согласно условиям фильтра.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      FilterStruct:Automaton.CMDB.ConfigItemFilterМодель фильтраСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ConfigitemsStruct:Automaton.CMDB.ConfigItemFilterResult (Array)Возвращает список моделей доступных конфигурационных единиц согласно фильтраСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

FilterConfigItemsExpanded

  • Назначение: Получение доступных КЕ по фильтру (Expanded)

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      IdsInteger64 (Array)Идентификатор КЕСвязь
      NamesString (Array)Название КЕСвязь
      LabelsDynamicМетки КЕСвязь
      StageCategoriesString (Array)Стадии жизненного цикла КЕСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ConfigItemsStruct:Automaton.CMDB.ConfigItemFilterResult (Array)Возвращает список моделей доступных конфигурационных единиц согласно фильтраСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

FilterConfigItemsExtended

  • Назначение: Получение доступных КЕ по фильтру (Extended)

  • Описание:

    • Особенностью данной функции является наличие нескольких дополнительных параметров для создании более точных запросов фильтрации

    • Возможность указать маску полей (fieldMask)

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      PagingPagingModelМодель постраничного запроса, с возможностью указать дополнительные параметры фильтрацииСвязь
      FieldMaskStringМаска возвращаемых полейСвязь
      IdsInteger64 (Array)Идентификаторы КЕСвязь
      NamesString (Array)Название КЕСвязь
      TypeIdsInteger64 (Array)Тип КЕСвязь
      StageCategoriesString (Array)Стадии жизненного цикла КЕСвязь
      LabelsDynamicМетки КЕСвязь
      AttributesDynamicАтрибуты КЕСвязь
      OwnerWorkGroupsInteger64 (Array)Владелец КЕСвязь
      FieldMask

      Представляет собой строку с названиями полей модели, разделёнными запятой.

      Если поле FieldMask не заполнено - будет возвращена полная модель КЕ, со всеми значениями полей.

    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ConfigItemsStruct:ConfigItemExtended (Array)Возвращает список моделей полученных конфигурационных единиц по фильтруСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

GetConfigItem

  • Назначение: Получение информации о КЕ

  • Описание: Функция выполняет запрос к API [GET] /api/public/sm/v2/rsm/config-items/{id}?includeState=false&includeHealth=false для получения информации о КЕ.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      IdInteger64Идентификатор КЕСвязь/контрол
      IncludeStateBooleanЕсли задано True – включить информацию по статусу КЕ. По умолчанию – FalseСвязь/контрол
      IncludeHealthBooleanЕсли задано True – включить информацию по здоровью КЕ. По умолчанию – FalseСвязь/контрол
    • Outputs

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

GetConfigItemsBatch

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      IdsInteger64 (Array)Список идентификаторов КЕ, по которым будет возвращена информацияСвязь
      IncludeStateBooleanПараметр определяет, возвращать ли информацию по стадии ЖЦ в модели КЕ или нетСвязь/контрол
      IncludeHealthBooleanПараметр определяет, возвращать ли информацию по здоровью в модели КЕ или нетСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ConfigItemsStruct:Automaton.CMDB.ConfigItem (Array)Массив моделей созданных КЕСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

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

CreateConfigItem

  • Назначение: Создание КЕ

  • Описание: Функция выполняет запрос к API [POST] /api/public/sm/v2/rsm/config-items?makeNameUnique=false для создания конфигурационной единицы.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ConfigItemStruct:Automaton.CMDB.ConfigItemPostМодель создаваемой КЕСвязь
      MakeNameIsUniqueBooleanПризнак уникальности названия конфигурационной единицы. Если True - КЕ будет создана с добавлением индекса к названию, если КЕ с таким названием уже существует. Если False и КЕ уже существует будет возвращена ошибка 400 и КЕ создана не будетСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ConfigItemsStruct:Automaton.CMDB.ConfigItemВозвращает модель созданной КЕСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

CreateConfigItemExpanded

  • Назначение: Создание КЕ (Expanded)

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      NameStringНазвание КЕСвязь/контрол
      DescriptionStringОписание КЕСвязь/контрол
      ParentIdInteger64Идентификатор родительской КЕСвязь/контрол
      ConfigItemTypeIdInteger64Идентификатор типа КЕСвязь/контрол
      OwnerWorkGroupIdInteger64Идентификатор РГ владельца КЕСвязь/контрол
      LabelsDynamicМетки КЕСвязь/контрол
      SharedToWorkGroupsStruct:Automaton.CMDB:WorkGroupGrantModelПредоставление доступа к КЕ другим Рабочим группамСвязь/контрол
      MakeNameIsUniqueBooleanПризнак уникальности названия конфигурационной единицы. Если True - КЕ будет создана с добавлением индекса к названию, если КЕ с таким названием уже существует. Если False и КЕ уже существует будет возвращена ошибка 400 и КЕ создана не будетСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ConfigItemStruct:Automaton.CMDB.ConfigItemВозвращает модель созданной КЕСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

CreateConfigItemsBatch

  • Назначение: Массовое создание КЕ

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ConfigItemPostsStruct:Automaton.CMDB.ConfigItemPost (Array)Массив объектов КЕСвязь
      MakeNameIsUniqueBooleanПризнак уникальности названия конфигурационной единицыСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ConfigitemsStruct:Automaton.CMDB.ConfigItemShort (Array)Массив моделей созданных КЕСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

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

DeleteConfigItem

  • Назначение: Удаление КЕ

  • Описание: Функция выполняет запрос к API [DELETE] /api/public/sm/v2/rsm/config-items/{id}?applyGrants=false для полного удаления конфигурационной единицы.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ConfigItemIdInteger64Идентификатор удаляемой КЕСвязь
      ApplyGrantsBooleanЕсли задано True – применить настройки доступа удаляемой КЕ к подчинённым КЕСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

DeleteConfigItemsBatch

  • Назначение: Массовое удаление КЕ

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь
      ConfigItemIdsInteger64 (array)Список идентификаторов удаляемых КЕСвязь
      ApplyGrantsBooleanЕсли задано True – применить настройки доступа удаляемой КЕ к подчинённым КЕСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

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

UpdateConfigItem

  • Назначение: Изменение основной информации о КЕ

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ConfigItemIdInteger64Идентификатор обновляемой КЕСвязь/контрол
      ConfigItemPutStruct:Automaton.CMDB.ConfigItemPutМодель обновленной КЕСвязь
      MakeNameIsUniqueBooleanПризнак уникальности названия конфигурационной единицы.Связь/контрол
    • Outputs

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

UpdateConfigItemExpanded

  • Назначение: Изменение основной информации о КЕ

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ConfigItemIdInteger64Идентификатор обновляемой КЕСвязь/контрол
      NameStringНазвание КЕСвязь/контрол
      DescriptionStringОписание КЕСвязь/контрол
      ParentIdInteger64Идентификатор родительской КЕСвязь/контрол
      ConfigItemTypeIdInteger64Идентификатор типа КЕСвязь/контрол
      OwnerWorkGroupIdInteger64Идентификатор РГ владельца КЕСвязь/контрол
      LabelsDynamicМетки КЕСвязь/контрол
      MakeNameIsUniqueBooleanПризнак уникальности названия конфигурационной единицы. Если True - КЕ будет создана с добавлением индекса к названию, если КЕ с таким названием уже существует. Если False и КЕ уже существует будет возвращена ошибка 400 и КЕ создана не будетСвязь/контрол
    • Outputs

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

UpdateConfigItemsBatch

  • Назначение: Пакетное обновление информации о КЕ

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ConfigItemsPatchStruct:ConfigItemPatchBatch (Array)Неполная модель КЕ, включает в себя обновление меток, типа КЕ и названияСвязь
      MakeNamesIsUniqueBooleanПризнак уникальности названия КЕ.
      True - к названию КЕ будет добавлен постфикс
      False - КЕ не будет переименована
      Связь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      UpdatedConfigItemsStruct:ConfigItemShort (Array)Массив неполных моделей обновленных КЕСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

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

UpdateInfluenceLinksBatch

  • Назначение: Массовое обновление связей влияния

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      InfluenceLinkPutModelsStruct:ConfigItemInfluenceLinkPutМодель связи влияния (Id исходной КЕ, Id целевой КЕ, Тип связи, Метки, Название компонента, Параметры здоровья)Связь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      InfluenceLinksStruct:ConfigItemInfluenceLink (array)Список моделей обновленных связей влиянияСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

PartialUpdateInfluenceLinksBatch

  • Назначение: Массовое (частичное) обновление связей влияния

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      InfluenceLinkPatchModelsStruct:ConfigItemInfluenceLinkPatchМодель связи влияния (Id исходной КЕ, Id целевой КЕ, Тип связи, Метки, Название компонента, Параметры здоровья)Связь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      InfluenceLinksStruct:ConfigItemInfluenceLink (array)Список моделей обновленных связей влиянияСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ParentIdInteger64Идентификатор родительской КЕСвязь/контрол
      ChildIdInteger64Идентификатор подчиняемой КЕСвязь/контрол
    • Outputs

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

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      DependentIdInteger64Идентификатор зависимой КЕСвязь/контрол
      InfluentialIdInteger64Идентификатор влияющей КЕСвязь/контрол
    • Outputs

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

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ParentIdInteger64Идентификатор родительской КЕСвязь/контрол
      ChildIdInteger64Идентификатор подчиненной КЕСвязь/контрол
    • Outputs

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

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      DependentIdInteger64Идентификатор зависимой КЕСвязь/контрол
      InfluentialIdInteger64Идентификатор влияющей КЕСвязь/контрол
    • Outputs

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

CreateLinksBatch

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      LinkPostModelsStruct:ConfigItemLinkPost (Array)Модель запроса для установки связейСвязь
      • SourceId - идентификатор КЕ, от которой идет связь подчинения или влияния
      • TargetId - идентификатор КЕ, к которой идет связь подчинения и влияния
      • Доступные типы связей:
        • Influence - связь влияния
        • Hierarchy - связь подчинения
        • Info - информационная связь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ConfigItemLinksStruct:ConfigItemInfluenceLink (Array)Массив моделей созданных связейСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

CreateInfluenceLinksBatch

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      InfluenceLinkPostModelsStruct:ConfigItemInfluenceLinkPost (Array)Модель запроса для установки связей влиянияСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ConfigItemLinksStruct:ConfigItemInfluenceLink (Array)Массив моделей созданных связейСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

UpdateLinksBatch

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      LinkPutModelsStruct:ConfigItemLinkPut (Array)Модель запроса для обновления связей любого типаСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ConfigItemLinksStruct:ConfigItemLinkPostResult (Array)Массив моделей обновленных связейСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

PartialUpdateLinksBatch

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      LinkPatchModelsStruct:ConfigItemLinkPatch (Array)Модель запроса для обновления связей любого типаСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ConfigItemLinksStruct:ConfigItemLinkPostResult (Array)Массив моделей обновленных связейСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

DeleteLinksBatch

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      LinkDeleteModelsStruct:ConfigItemLinkDelete (Array)Модель запроса для удаления связейСвязь
      • SourceId - идентификатор КЕ, от которой идет связь подчинения или влияния
      • TargetId - идентификатор КЕ, к которой идет связь подчинения и влияния
      • Доступные типы связей для удаления:
        • Influence - связь влияния
        • Hierarchy - связь подчинения
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ConfigItemLinksStruct:ConfigItemInfluenceLink (Array)Массив моделей созданных связейСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

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

подсказка

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

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

GrantAccessToConfigItem

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ConfigItemIdInteger64Идентификатор обновляемой КЕСвязь/контрол
      WorkGroupGrantStruct:Automaton.CMDB.WorkGroupGrantModelМодель запросаСвязь
    • Outputs

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

GrantAccessToConfigItemExpanded

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ConfigItemIdInteger64Идентификатор обновляемой КЕСвязь/контрол
      WorkGroupIdInteger64Идентификатор рабочей группы, которой предоставляется доступ к КЕСвязь/контрол
      ShareTypeStringТип предоставляемых правСвязь/контрол
      GrantsString (Array)Предоставляемые рабочим группам праваСвязь
      Справка

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

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

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

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

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

UpdateAccessToConfigItem

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ConfigItemIdInteger64Идентификатор обновляемой КЕСвязь/контрол
      WorkGroupGrantStruct:Automaton.CMDB.WorkGroupGrantModelМодель запросаСвязь
    • Outputs

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

UpdateAccessToConfigItemExpanded

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ConfigItemIdInteger64Идентификатор обновляемой КЕСвязь/контрол
      WorkGroupIdInteger64Идентификатор рабочей группы, которой предоставляется доступ к КЕСвязь/контрол
      ShareTypeStringТип предоставляемых правСвязь/контрол
      GrantsString (Array)Предоставляемые рабочим группам праваСвязь
    • Outputs

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

DeleteAccessToConfigItem

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ConfigItemIdInteger64Идентификатор обновляемой КЕСвязь/контрол
      SharedWorkGroupIdInteger64Идентификатор модели предоставления доступа к КЕСвязь/контрол
    • Outputs

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

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

SetStageById

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ConfigItemIdInteger64Идентификатор зависимой КЕСвязь/контрол
      StageIdInteger64Идентификатор стадии жизненного циклаСвязь/контрол
      ApplyGrantsBooleanЕсли задано True – применить настройки доступа к подчинённым КЕ. По умолчанию – False.Связь/контрол
    • Outputs

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

SetStageByCategory

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ConfigItemIdInteger64Идентификатор зависимой КЕСвязь/контрол
      CategoryStringНазвание категории стадии жизненного цикла КЕСвязь/контрол
      ApplyGrantsBooleanЕсли задано True – применить настройки доступа к подчинённым КЕ. По умолчанию – False.Связь/контрол
    • Outputs

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

SetStageByCategoryBatch

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      StageCategoryPostsStruct:StageCategoryPostBatch (Array)Модель запроса. Доступные категории ЖЦ: Active, Archive, DeletedСвязь
    • Outputs

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

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

FilterAttributesConfigItem

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      AttributeFilterStruct:Automaton.CMDB.AttributeFilterМодель фильтра атрибутовСвязь
    • Outputs

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

FilterAttributesConfigItemExpanded

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ConfigItemIdsInteger64 (Array)Список идентификаторов КЕСвязь/контрол
      KeyValuesStruct:Automaton.CMDB.AttributeFilterKeyValue (Array)Список моделей атрибутов КЕСвязь/контрол
    • Outputs

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

CreateAttribute

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      AttributeRequestStruct:Automaton.CMDB.AttributeRequestМодель объекта атрибутаСвязь
      ConfigItemIdInteger64Идентификатор КЕСвязь/контрол
    • Outputs

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

CreateAttributeExpanded

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ConfigItemIdInteger64Идентификатор КЕСвязь/контрол
      KeyStringКлюч атрибута КЕСвязь/контрол
      ValueDynamicЗначение атрибута КЕСвязь
    • Outputs

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

UpdateAttribute

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      AttributeRequestStruct:Automaton.CMDB.AttributeRequestОбновленная модель атрибута КЕСвязь/контрол
      ConfigItemIdInteger64Идентификатор КЕСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      UpdatedAttributeStruct:Automaton.CMDB.AttributeОбновленная модель атрибута КЕСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

UpdateConfigItemAttributesBatch

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      AttributePutModelsStruct:Automaton.CMDB.AttributePutBatch (Array)Модель атрибута КЕ (идентификатор КЕ, ключ и значение атрибута)Связь
    • Outputs

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

UpdateAttributeExpanded

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ConfigItemIdInteger64Идентификатор КЕСвязь/контрол
      KeyStringКлюч атрибута КЕСвязь/контрол
      ValueDynamicЗначение атрибута КЕСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      UpdatedAttributeStruct:Automaton.CMDB.AttributeОбновленная модель атрибута КЕСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

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

UpdateConfigItemComponent

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ConfigItemComponentPutModelStruct:ConfigItemComponentPutМодель запроса для обновления параметров компонента КЕСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ComponentStruct:ConfigItemComponentМодель обновленного компонентаСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

PartialUpdateConfigItemComponent

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ConfigItemComponentPatchModelStruct:ConfigItemComponentPatchМодель запроса для обновления параметров компонента КЕСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ComponentStruct:ConfigItemComponentМодель обновленного компонентаСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

UpdateConfigItemComponentsBatch

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ConfigItemComponentPutModelsStruct:ConfigItemComponentPutModels (array)Список моделей для обновления параметров компонента КЕСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ComponentsStruct:ConfigItemComponent (array)Список моделей обновленного компонентаСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

PartialUpdateConfigItemComponentsBatch

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ConfigItemComponentPatchModelsStruct:ConfigItemComponentPatchModels (array)Список моделей для обновления параметров компонента КЕСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ComponentsStruct:ConfigItemComponent (array)Список моделей обновленного компонентаСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

FilterConfigItemComponents

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      IdsInteger64 (array)Идентификаторы компонентов, полную информацию о которых нужно получить в ответеСвязь
      NamesString (array)Названия компонентов, полную информацию о которых нужно получить в ответеСвязь
      ConfigItemIdsInteger64 (array)Идентификаторы КЕ, информацию о компонентах которой нужно получить в ответеСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ComponentsStruct:ConfigItemComponent (array)Список моделей полученных компонентовСвязь
      ResponseStruct:AutomatonResponseВозвращает результат выполнения запроса согласно модели AutomatonResponseСвязь

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

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

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

GetMaintenances

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      PagingStruct:PagingModelМодель постраничного запросаСвязь
    • Outputs

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

GetMaintenanceById

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      MaintenanceIdInteger64Идентификатор режима обслуживанияСвязь
    • Outputs

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

FilterMaintenances

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      PagingStruct:PagingModelМодель постраничного запросаСвязь
      IdsInteger64 (array)Список идентификаторов режимов обслуживанияСвязь
      DateStartStruct:DatePostДата начала режима обслуживанияСвязь
      DateEndStruct:DatePostДата окончания режима обслуживанияСвязь
      СonfigItemIdsInteger64 (array)Список идентификаторов связанных КЕСвязь
    • Outputs

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

CreateMaintenance

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      BatchValidateBooleanВыполняется проверка для всех КЕ на то, что они зарегистрированы в системе и доступны пользователю на установку сервисного режимаСвязь
      DateStartStruct:DatePostДата начала режима обслуживанияСвязь
      DateEndStruct:DatePostДата окончания режима обслуживанияСвязь
      TitleStringНазвание режима обслуживанияСвязь
      ConfigItemsStruct:ConfigItemToMaintenancePost (array)Список моделей связанных КЕСвязь
      LabelsDynamicМетки в формате ключ : значениеСвязь
    • Outputs

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

Struct:ConfigItemToMaintenancePost

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

ПинТипОписание
IdInteger64Идентификатор КЕ
ScopeEnumСпособ распространения режима обслуживания по графу
DepthInteger64Глубина распространения по графу

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

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

UpdateMaintenance

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      IdInteger64Идентификатор режима обслуживанияСвязь/контрол
      BatchValidateBooleanВыполняется проверка для всех КЕ на то, что они зарегистрированы в системе и доступны пользователю на установку сервисного режимаСвязь
      DateStartStruct:DatePostДата начала режима обслуживанияСвязь
      DateEndStruct:DatePostДата окончания режима обслуживанияСвязь
      TitleStringНазвание режима обслуживанияСвязь
      ConfigItemsStruct:ConfigItemToMaintenancePost (array)Список моделей связанных КЕСвязь
      LabelsDynamicМетки в формате ключ : значениеСвязь
    • Outputs

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

PartialUpdateMaintenance

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      IdInteger64Идентификатор режима обслуживанияСвязь/контрол
      BatchValidateBooleanВыполняется проверка для всех КЕ на то, что они зарегистрированы в системе и доступны пользователю на установку сервисного режимаСвязь
      DateStartStruct:DatePostДата начала режима обслуживанияСвязь
      DateEndStruct:DatePostДата окончания режима обслуживанияСвязь
      TitleStringНазвание режима обслуживанияСвязь
      ConfigItemsStruct:ConfigItemToMaintenancePost (array)Список моделей связанных КЕСвязь
      LabelsDynamicМетки в формате ключ : значениеСвязь
      CancelBooleanЕсли True - режим обслуживания будет отменён, если запланирован или завершен, если активенСвязь
    • Outputs

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