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

Управление атрибутами КЕ

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

POST /api/public/sm/v2/rsm/config-items/attributes/filter

Возвращает список моделей атрибутов КЕ.

Тело запроса

{
"ids": [1, 2, 3],
"keyValues": [{
"key": "key1",
"values": [{
"prop1": "value1",
"prop2": "value2"
}]
}]
}

Поля тела запроса

Название поляТип поляОбязательное полеЗначение по умолчаниюОписание поля
idsinteger[]нетnullСписок идентификаторов КЕ. Если null, то любые
keyValuesobject[]нетnullСписок фильтров по паре ключ-значение, объединяемых логическим И. Если null, то все

Коды ответа

Код ответаОписание
200Запрос успешно исполнен
401Не удалось выполнить авторизацию пользователя
500Непредвиденная ошибка при обработке запроса

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

POST /api/public/sm/v2/rsm/config-items/{id}/attributes

При успешном выполнении запроса возвращается модель атрибута КЕ.

Параметры запроса

Название параметраТип параметраОбязательный параметрЗначение по умолчаниюОписание параметра
idintegerданетИдентификатор КЕ

Тело запроса

{
"key": "key1",
"value": {
"prop1": "value1",
"prop2": "value2"
}
}

Поля тела запроса

Название поляТип поляОбязательное полеЗначение по умолчаниюОписание поля
keystringданетКлюч атрибута
valueobjectнетnullЗначение атрибута

Коды ответа

Код ответаОписание
400Ключ {key} уже определён
400Ключ {key} не разрешен
403Нет прав для создания атрибута КЕ

Создание атрибута КЕ пакетно

POST /api/public/sm/v2/rsm/config-items/attributes/batch

При успешном выполнении запроса возвращается список моделей атрибутов КЕ.

Тело запроса

[
{
"configItemId": 1,
"key": "key1",
"value": {
"prop1": "value1",
"prop2": "value2"
}
},
{
"configItemId": 2,
"key": "key1",
"value": {
"prop1": "value1",
"prop2": "value2"
}
}
]

Поля тела запроса

Название поляТип поляОбязательное полеЗначение по умолчаниюОписание поля
configItemIdintegerданетИдентификатор КЕ
keystringданетКлюч атрибута
valueobjectнетnullЗначение атрибута

Коды ответа

Код ответаОписание
400Ключ {key} уже определён
400Ключ {key} не разрешен
403Нет прав для создания атрибута КЕ

Обновление атрибута КЕ

PUT /api/public/sm/v2/rsm/config-items/{id}/attributes

При успешном выполнении запроса возвращается модель атрибута КЕ.

Параметры запроса

Название параметраТип параметраОбязательный параметрЗначение по умолчаниюОписание параметра
idintegerданетИдентификатор КЕ

Тело запроса

{
"key": "key1",
"value": {
"prop1": "value1",
"prop2": "value2"
}
}

Поля тела запроса

Название поляТип поляОбязательное полеЗначение по умолчаниюОписание поля
keystringданетКлюч атрибута
valueobjectнетnullЗначение атрибута

Коды ответа

Код ответаОписание
400Ключ {key} уже определён
403Нет прав для создания атрибута КЕ
404Атрибут КЕ с ключом {key} не найден

Обновление атрибута КЕ пакетно

PUT /api/public/sm/v2/rsm/config-items/attributes/batch

При успешном выполнении запроса возвращается список обновленных моделей атрибутов КЕ.

Тело запроса

[
{
"configItemId": 1,
"key": "key1",
"value": {
"prop1": "value1",
"prop2": "value2"
}
},
{
"configItemId": 2,
"key": "key1",
"value": {
"prop1": "value1",
"prop2": "value2"
}
}
]

Поля тела запроса

Название поляТип поляОбязательное полеЗначение по умолчаниюОписание поля
configItemIdintegerданетИдентификатор КЕ
keystringданетКлюч атрибута
valueobjectнетnullЗначение атрибута

Коды ответа

Код ответаОписание
400Ключ {key} уже определён
400Ключ {key} не разрешен
403Нет прав для создания атрибута КЕ