PUT объект

Материал из Dynatrace
Версия от 16:47, 9 февраля 2023; ENetrebin (обсуждение | вклад)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Обновляет указанный объект настроек.

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

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

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

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

Параметры

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

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

Объект SettingsObjectUpdate

Обновление объекта настроек.

Элемент Тип Описание Необходимость
schemaVersion string Версия схемы, на которой основан объект. по желанию
updateToken string Токен обновления объекта. Вы можете использовать его для обнаружения одновременных изменений разными пользователями.

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

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

по желанию
insertAfter string Положение обновленного объекта. Новый объект будет перемещен за указанный.

insertAfter и insertBefore оцениваются вместе, и может быть установлен только один из них.

Если nullи insertBefore 'null', существующий объект сохраняет текущую позицию.

Если указать пустую строку, обновленный объект будет помещен в первую позицию.

Применимо только к объектам, основанным на схемах с упорядоченными объектами ( параметру упорядоченияtrue схемы присвоено значение ).

по желанию
insertBefore string Положение обновленного объекта. Новый объект будет перемещен перед указанным.

insertAfter и insertBefore оцениваются вместе, и может быть установлен только один из них.

Если nullи insertAfter 'null', существующий объект сохраняет текущую позицию.

Если указать пустую строку, обновленный объект будет помещен в последнюю позицию.

Применимо только к объектам, основанным на схемах с упорядоченными объектами ( параметру упорядоченияtrue схемы присвоено значение ).

по желанию
value SettingsValue Значение настройки.

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

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

требуется

Объект SettingsValue

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

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

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

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

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

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

{
  "schemaVersion": "1.0.0",
  "updateToken": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
  "insertAfter": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
  "insertBefore": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
  "value": {
    "autoMonitoring": true
  }
}

Ответ

Коды ответов

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

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

Объект 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"
  }
}