Атрибуты и компоненты КЕ

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

---

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

FilterAttributesConfigItem

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

Inputs

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

Outputs

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

FilterAttributesConfigItemExpanded

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

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
ConfigItemIds	Integer64 (array)	Список идентификаторов КЕ
KeyValues	Struct: Automaton.CMDB.AttributeFilterKeyValue (array)	Список моделей атрибутов КЕ

Outputs

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

​

Значение (Value) с типом Dynamic Single нужно обязательно завернуть в массив Dynamic Array:

CreateAttribute

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

Inputs

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

Outputs

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

CreateAttributeExpanded

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

Inputs

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

Outputs

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

UpdateAttribute

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

Inputs

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

Outputs

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

UpdateAttributeExpanded

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

Inputs

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

Outputs

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

UpdateConfigItemAttributesBatch

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

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
AttributePutModels	Struct: Automaton.CMDB.AttributePutBatch (array)	Модель атрибута КЕ (идентификатор КЕ, ключ и значение атрибута)

Outputs

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

---

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

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

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

FilterConfigItemComponents

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

Inputs

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

Outputs

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

UpdateConfigItemComponent

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

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
ConfigItemComponentPutModel	Struct: ConfigItemComponentPut	Модель запроса для обновления параметров компонента КЕ

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
Component	Struct: ConfigItemComponent	Модель обновленного компонента

PartialUpdateConfigItemComponent

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

Обновляются только те значения параметров компонента, которые переданы на вход.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
ConfigItemComponentPatchModel	Struct: ConfigItemComponentPatch	Модель запроса для обновления параметров компонента КЕ

Outputs

Название	Тип	Описание
Ok, Failed, Response		Общие параметры для функций
Component	Struct: ConfigItemComponent	Модель обновленного компонента

UpdateConfigItemComponentsBatch

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

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

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
ConfigItemComponentPutModels	Struct: ConfigItemComponentPutModels (array)	Список моделей для обновления параметров компонента КЕ

Outputs

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

PartialUpdateConfigItemComponentsBatch

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

Обновляются только те значения параметров компонентов, которые переданы на вход.

Inputs

Название	Тип	Описание
In, BearerToken		Общие параметры для функций
ConfigItemComponentPatchModels	Struct: ConfigItemComponentPatchModels (array)	Список моделей для обновления параметров компонента КЕ

Outputs

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