POST объект

Создает новый объект настроек или проверяет предоставленный объект настроек.

Запрос создает и использует в качестве полезной нагрузки application/json формат.

POST	Managed	https://{your-domain}/e/{your-environment-id}/api/v2/settings/objects
	Среда ActiveGate	https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/objects

Аутентификация

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Write settings ( settings.write) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр	Тип	Описание	In	Необходимость
validateOnly	boolean	Если true, запрос выполняет только проверку отправленных объектов настроек, не сохраняя их.	query	по желанию
body	SettingsObjectCreate[]	Тело JSON запроса. Содержит объекты настроек.	body	по желанию

Объекты тела запроса

Объект RequestBody

Объект не предоставляет никаких параметров.

Объект SettingsObjectCreate

Конфигурация нового объекта настроек.

Элемент	Тип	Описание	Необходимость
schemaVersion	string	Версия схемы, на которой основан объект.	по желанию
insertAfter	string	Положение нового объекта. Новый объект будет добавлен после указанного. Если null, новый объект будет помещен в последнюю позицию. Если указать пустую строку, новый объект будет помещен в первую позицию. Применимо только к объектам, основанным на схемах с упорядоченными объектами ( параметру упорядоченияtrue схемы присвоено значение ).	по желанию
externalId	string	Внешний идентификатор создаваемого объекта	по желанию
schemaId	string	Схема, на которой основан объект.	требуется
scope	string	Область, на которую нацелен объект. Если опущено при создании нового объекта и если схема поддерживает создание области, операция создаст область из предоставленного значения.	по желанию
value	SettingsValue	Значение настройки. Он определяет фактические значения параметров настроек. Фактическое содержимое зависит от схемы объекта.	требуется

Объект SettingsValue

Значение настройки.

Он определяет фактические значения параметров настроек.

Фактическое содержимое зависит от схемы объекта.

Объект не предоставляет никаких параметров.

JSON-модель тела запроса

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.

[
  {
    "schemaVersion": "1.0.0",
    "insertAfter": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
    "externalId": "string",
    "schemaId": "builtin:container.built-in-monitoring-rule",
    "scope": "HOST-D3A3C5A146830A79",
    "value": {
      "autoMonitoring": true
    }
  }
]

Ответ

Коды ответов

Код	Тип	Описание
200	SettingsObjectResponse[]	Успех
207	SettingsObjectResponse	Мультистатус: разные объекты полезной нагрузки имеют разные статусы.
400	SettingsObjectResponse	Не удалось. Проверка схемы не удалась.
403	ErrorEnvelope	Не удалось. Запрещенный.
404	SettingsObjectResponse	Не удалось. Запрошенный ресурс не существует.
409	SettingsObjectResponse	Не удалось. Конфликтный ресурс.

Объекты тела ответа

Объект ResponseBody

Объект не предоставляет никаких параметров.

Объект SettingsObjectResponse

Ответ на запрос на создание или обновление.

Элемент	Тип	Описание
invalidValue	SettingsValue	Значение настройки. Он определяет фактические значения параметров настроек. Фактическое содержимое зависит от схемы объекта.
objectId	string	При успешном запросе идентификатор созданного или измененного объекта настроек.
code	integer	Код состояния HTTP для объекта.
error	Error	-

Объект SettingsValue

Значение настройки.

Он определяет фактические значения параметров настроек.

Фактическое содержимое зависит от схемы объекта.

Объект не предоставляет никаких параметров.

Объект Error

Элемент	Тип	Описание
constraintViolations	ConstraintViolation[]	Список нарушений ограничений
code	integer	Код состояния HTTP
message	string	Сообщение об ошибке

Объект ConstraintViolation

Список нарушений ограничений

Элемент	Тип	Описание
parameterLocation	string	- Элемент может содержать эти значения PATH PAYLOAD_BODY QUERY
location	string	-
message	string	-
path	string	-

JSON-модель тела ответа

[
  {
    "invalidValue": {
      "autoMonitoring": true
    },
    "objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
    "code": 1,
    "error": {
      "constraintViolations": [
        {
          "parameterLocation": "PATH",
          "location": "string",
          "message": "string",
          "path": "string"
        }
      ],
      "code": 1,
      "message": "string"
    }
  }
]