Управление атрибутами КЕ
Получение атрибутов КЕ по фильтру
POST /api/public/sm/v2/rsm/config-items/attributes/filter
Возвращает список моделей атрибутов КЕ.
Тело запроса
{
"ids": [1, 2, 3],
"keyValues": [{
"key": "key1",
"values": [{
"prop1": "value1",
"prop2": "value2"
}]
}]
}
Поля тела запроса
| Название поля | Тип поля | Обязательное поле | Значение по умолчанию | Описание поля |
|---|---|---|---|---|
| ids | integer[] | нет | null | Список идентификаторов КЕ. Если null, то любые |
| keyValues | object[] | нет | null | Список фильтров по паре ключ-значение, объединяемых логическим И. Если null, то все |
Коды ответа
| Код ответа | Описание |
|---|---|
| 200 | Запрос успешно исполнен |
| 401 | Не удалось выполнить авторизацию пользователя |
| 500 | Непредвиденная ошибка при обработке запроса |
Создание атрибута КЕ
POST /api/public/sm/v2/rsm/config-items/{id}/attributes
При успешном выполнении запроса возвращается модель атрибута КЕ.
Параметры запроса
| Название параметра | Тип параметра | Обязательный параметр | Значение по умолчанию | Описание параметра |
|---|---|---|---|---|
| id | integer | да | нет | Идентификатор КЕ |
Тело запроса
{
"key": "key1",
"value": {
"prop1": "value1",
"prop2": "value2"
}
}
Поля тела запроса
| Название поля | Тип поля | Обязательное поле | Значение по умолчанию | Описание поля |
|---|---|---|---|---|
| key | string | да | нет | Ключ атрибута |
| value | object | нет | 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"
}
}
]
Поля тела запроса
| Название поля | Тип поля | Обязательное поле | Значение по умолчанию | Описание поля |
|---|---|---|---|---|
| configItemId | integer | да | нет | Идентификатор КЕ |
| key | string | да | нет | Ключ атрибута |
| value | object | нет | null | Значение атрибута |
Коды ответа
| Код ответа | Описание |
|---|---|
| 400 | Ключ {key} уже определён |
| 400 | Ключ {key} не разрешен |
| 403 | Нет прав для создания атрибута КЕ |
Обновление атрибута КЕ
PUT /api/public/sm/v2/rsm/config-items/{id}/attributes
При успешном выполнении запроса возвращается модель атрибута КЕ.
Параметры запроса
| Название параметра | Тип параметра | Обязательный параметр | Значение по умолчанию | Описание параметра |
|---|---|---|---|---|
| id | integer | да | нет | Идентификатор КЕ |
Тело запроса
{
"key": "key1",
"value": {
"prop1": "value1",
"prop2": "value2"
}
}
Поля тела запроса
| Название поля | Тип поля | Обязательное поле | Значение по умолчанию | Описание поля |
|---|---|---|---|---|
| key | string | да | нет | Ключ атрибута |
| value | object | нет | 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"
}
}
]
Поля тела запроса
| Название поля | Тип поля | Обязательное поле | Значение по умолчанию | Описание поля |
|---|---|---|---|---|
| configItemId | integer | да | нет | Идентификатор КЕ |
| key | string | да | нет | Ключ атрибута |
| value | object | нет | null | Значение атрибута |
Коды ответа
| Код ответа | Описание |
|---|---|
| 400 | Ключ {key} уже определён |
| 400 | Ключ {key} не разрешен |
| 403 | Нет прав для создания атрибута КЕ |