DELETE объект

Материал из Документация Ключ-АСТРОМ

Обновляет указанный объект настроек. Удаление не может быть отменено!

DELETE Managed https://{your-domain}/e/{your-environment-id}/api/v2/settings/objects/{objectId}
Среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/objects/{objectId}

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

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

Параметры

Параметр Тип Описание In Необходимость
objectId string Идентификатор требуемого объекта настроек. path требуется
updateToken string Токен обновления объекта. Вы можете использовать его для обнаружения одновременных изменений разными пользователями.

Генерируется при извлечении (запросы GET). Если установлено при обновлении (запрос PUT) или удалении, обновление/удаление будет разрешено только в том случае, если не было никаких изменений между получением и обновлением.

Если опущено при обновлении/удалении, операция переопределяет текущее значение или удаляет его без каких-либо проверок.

query по желанию

Ответ

Коды ответов

Код Тип Описание
204 Успех. Ответ не имеет тела.
400 SettingsObjectResponse Не удалось. Проверка схемы не удалась.
403 ErrorEnvelope Не удалось. Запрещенный.
404 SettingsObjectResponse Не удалось. Запрошенный ресурс не существует.
409 SettingsObjectResponse Не удалось. Конфликтный ресурс.