Поиск, создание, обновление и удаление КЕ

Раздел описывает CRUD-функции для конфигурационных единиц – от поиска и получения информации до создания, обновления и удаления, включая пакетные операции и расширенные возможности фильтрации.

---

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

GetConfigItem

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

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
Id	Integer64	Идентификатор КЕ
IncludeState	Boolean	Если задано True – включить информацию по статусу КЕ По умолчанию: False
IncludeHealth	Boolean	Если задано True – включить информацию по здоровью КЕ По умолчанию: False

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
ConfigItem	Struct: Automaton.CMDB.ConfigItem	Модель обновленной КЕ

GetConfigItemsBatch

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

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
Ids	Integer64 (array)	Список идентификаторов КЕ, по которым будет возвращена информация
IncludeState	Boolean	Параметр определяет, возвращать ли информацию по стадии ЖЦ в модели КЕ
IncludeHealth	Boolean	Параметр определяет, возвращать ли информацию по здоровью в модели КЕ

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
ConfigItems	Struct: Automaton.CMDB.ConfigItem (array)	Массив моделей созданных КЕ

GetConfigItemByUniqueKey

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

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

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
ConfigItemTypeId	Integer64	Идентификатор типа КЕ
Attributes	Dynamic	Ключевые параметры атрибутов

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
ConfigItem	Struct: Automaton.CMDB.ConfigItemByUniqueKey (single)	Упрощенная модель КЕ (ID и стадия ЖЦ)

GetAllConfigItems

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

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
WorkGroups	Struct: Automaton.CMDB.ConfigItemShort (array)	Возвращает список моделей доступных конфигурационных единиц

FilterConfigItems

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

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
Filter	Struct: Automaton.CMDB.ConfigItemFilter	Модель фильтра

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
Configitems	Struct: Automaton.CMDB.ConfigItemFilterResult (array)	Возвращает список моделей доступных конфигурационных единиц согласно фильтра

FilterConfigItemsExpanded

Назначение: Получение доступных КЕ по фильтру (Expanded)
Описание: Функция аналогична функции FilterConfigItems за исключением входящих в нее пинов.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
Ids	Integer64 (array)	Идентификатор КЕ
Names	String (array)	Название КЕ
Labels	Dynamic	Метки КЕ
StageCategories	String (array)	Стадии жизненного цикла КЕ

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
ConfigItems	Struct: Automaton.CMDB.ConfigItemFilterResult (array)	Возвращает список моделей доступных конфигурационных единиц согласно фильтра

FilterConfigItemsExtended

Назначение: Получение доступных КЕ по фильтру (Extended)
Описание: Особенностью данной функции является наличие нескольких дополнительных параметров для создании более точных запросов фильтрации, а также возможность указать маску полей (fieldMask)

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
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). Значения полей указываются в camelCase и являются регистрозависимыми.

Если поле FieldMask не заполнено - будет возвращена полная модель КЕ, со всеми значениями полей. Данный параметр позволяет облегчить запрос к API путем указания только нужных полей в ответе.

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
ConfigItems	Struct: ConfigItemExtended (array)	Возвращает список моделей полученных конфигурационных единиц по фильтру

GetConfigItemTypes

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

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
ConfigItemTypes	Struct: Automaton.CMDB.ConfigItemType (array)	Возвращает список моделей типов КЕ

---

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

CreateConfigItem

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

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
ConfigItem	Struct: Automaton.CMDB.ConfigItemPost	Модель создаваемой КЕ
MakeNameIsUnique	Boolean	Признак уникальности названия конфигурационной единицы*

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
ConfigItems	Struct: Automaton.CMDB.ConfigItem	Возвращает модель созданной КЕ

*MakeNameIsUnique

• Если True и КЕ с таким названием уже существует - КЕ будет создана с добавлением индекса к названию
• Если False и КЕ с таким названием уже существует - КЕ создана не будет и вернется ошибка 400

CreateConfigItemExpanded

Назначение: Создание КЕ (Expanded)
Описание: Аналогична функции CreateConfigItem за исключением входящих в нее пинов.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
Name	String	Название КЕ
Description	String	Описание КЕ
ParentId	Integer64	Идентификатор родительской КЕ
ConfigItemTypeId	Integer64	Идентификатор типа КЕ
OwnerWorkGroupId	Integer64	Идентификатор РГ владельца КЕ
Labels	Dynamic	Метки КЕ
SharedToWorkGroups	Struct: Automaton.CMDB:WorkGroupGrantModel	Предоставление доступа к КЕ другим Рабочим группам
MakeNameIsUnique	Boolean	Признак уникальности названия конфигурационной единицы*

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
ConfigItem	Struct: Automaton.CMDB.ConfigItem	Возвращает модель созданной КЕ

*MakeNameIsUnique

• Если True и КЕ с таким названием уже существует - КЕ будет создана с добавлением индекса к названию
• Если False и КЕ с таким названием уже существует - КЕ создана не будет и вернется ошибка 400

CreateConfigItemsBatch

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

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
ConfigItemPosts	Struct: Automaton.CMDB.ConfigItemPost (array)	Массив объектов КЕ
MakeNameIsUnique	Boolean	Признак уникальности названия конфигурационной единицы*

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
Configitems	Struct: Automaton.CMDB.ConfigItemShort (array)	Массив моделей созданных КЕ

*MakeNameIsUnique

• Если True и КЕ с таким названием уже существует - КЕ будет создана с добавлением индекса к названию
• Если False и КЕ с таким названием уже существует - КЕ создана не будет и вернется ошибка 400

---

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

UpdateConfigItem

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

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
ConfigItemId	Integer64	Идентификатор обновляемой КЕ
ConfigItemPut	Struct: Automaton.CMDB.ConfigItemPut	Модель обновленной КЕ
MakeNameIsUnique	Boolean	Признак уникальности названия конфигурационной единицы

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
UpdatedConfigItem	Struct: Automaton.CMDB.ConfigItem	Модель обновленной КЕ

UpdateConfigItemExpanded

Назначение: Изменение основной информации о КЕ
Описание: Функция аналогична функции UpdateConfigItem за исключением входящих в нее пинов.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
ConfigItemId	Integer64	Идентификатор обновляемой КЕ
Name	String	Название КЕ
Description	String	Описание КЕ
ParentId	Integer64	Идентификатор родительской КЕ
ConfigItemTypeId	Integer64	Идентификатор типа КЕ
OwnerWorkGroupId	Integer64	Идентификатор РГ владельца КЕ
Labels	Dynamic	Метки КЕ
MakeNameIsUnique	Boolean	Признак уникальности названия конфигурационной единицы*

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
UpdatedConfigItem	Struct: Automaton.CMDB.ConfigItem	Модель обновленной КЕ

*MakeNameIsUnique

• Если True и КЕ с таким названием уже существует - КЕ будет обновлена с добавлением индекса к названию
• Если False и КЕ с таким названием уже существует - КЕ обновлена не будет и вернется ошибка 400

UpdateConfigItemsBatch

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

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
ConfigItemsPatch	Struct: ConfigItemPatchBatch (array)	Неполная модель КЕ, включает в себя обновление меток, типа КЕ и названия
MakeNamesIsUnique	Boolean	Признак уникальности названия конфигурационной единицы*

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
UpdatedConfigItems	Struct: ConfigItemShort (array)	Массив неполных моделей обновленных КЕ

*MakeNameIsUnique

• Если True и КЕ с таким названием уже существует - КЕ будет обновлена с добавлением индекса к названию
• Если False и КЕ с таким названием уже существует - КЕ обновлена не будет

---

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

DeleteConfigItem

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

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
ConfigItemId	Integer64	Идентификатор удаляемой КЕ
ApplyGrants	Boolean	Если задано True – применить настройки доступа удаляемой КЕ к подчиненным КЕ

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций

DeleteConfigItemsBatch

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

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
ConfigItemIds	Integer64 (array)	Список идентификаторов удаляемых КЕ
ApplyGrants	Boolean	Если задано True – применить настройки доступа удаляемой КЕ к подчиненным КЕ

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций