IKuznetsov в 16:48, 2 января 2025

2025-01-02T16:48:40Z

← Предыдущая версия		Версия от 16:48, 2 января 2025
Строка 1:		Строка 1:
			'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D0%BE%D0%B4%D0%B8%D0%BD%20SLO-,%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B8,-%D0%9E%D0%B1%D1%8A%D0%B5%D0%BA%D1%82%D1%8B Настройки] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B8-,%D0%9E%D0%B1%D1%8A%D0%B5%D0%BA%D1%82%D1%8B,-GET%20%D0%BE%D0%B1%D1%8A%D0%B5%D0%BA%D1%82%D1%8B Объекты] / PUT объект'''''

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

Строка 114:		Строка 116:
	"autoMonitoring": true		"autoMonitoring": true
	}		}
	}~~</code>~~		}

	== Ответ ==		== Ответ ==
Строка 251:		Строка 253:
	"message": "string"		"message": "string"
	}		}
	}~~</code>~~		}

IKuznetsov в 10:29, 26 декабря 2024

2024-12-26T10:29:14Z

← Предыдущая версия		Версия от 10:29, 26 декабря 2024
Строка 4:		Строка 4:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|PUT		\| rowspan="2" \|PUT
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/settings/objects/{objectId}</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/settings/objects/{objectId}</nowiki></code>
	\|-		\|-
Строка 106:		Строка 106:
	=== JSON-модель тела запроса ===		=== JSON-модель тела запроса ===
	Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.		Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
	<~~code>~~{		<{
	"schemaVersion": "1.0.0",		"schemaVersion": "1.0.0",
	"updateToken": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",		"updateToken": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
Строка 233:		Строка 233:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"invalidValue": {		"invalidValue": {
	"autoMonitoring": true		"autoMonitoring": true

ENetrebin: Новая страница: «Обновляет указанный объект настроек. Запрос создает и использует в качестве полезной н...»

2022-10-20T09:40:34Z

Новая страница: «Обновляет указанный объект настроек. Запрос создает и использует в качестве полезной н...»

Новая страница

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

Запрос создает и использует в качестве полезной нагрузки <code>application/json</code> формат.
{| class="wikitable"
| rowspan="2" |PUT
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/settings/objects/{objectId}</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/objects/{objectId}</nowiki></code>
|}

== Аутентификация ==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Write settings ( <code>settings.write</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .

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

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

==== Объект <code>SettingsObjectUpdate</code> ====
Обновление объекта настроек.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|schemaVersion
|string
|Версия схемы, на которой основан объект.
|по желанию
|-
|updateToken
|string
|Токен обновления объекта. Вы можете использовать его для обнаружения одновременных изменений разными пользователями.

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

Если опущено при обновлении/удалении, операция переопределяет текущее значение или удаляет его без каких-либо проверок.
|по желанию
|-
|insertAfter
|string
|Положение обновленного объекта. Новый объект будет перемещен за указанный.

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

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

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

Применимо только к объектам, основанным на схемах с упорядоченными объектами ( параметру упорядочения<code>true</code> схемы присвоено значение ).
|по желанию
|-
|insertBefore
|string
|Положение обновленного объекта. Новый объект будет перемещен перед указанным.

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

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

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

Применимо только к объектам, основанным на схемах с упорядоченными объектами ( параметру упорядочения<code>true</code> схемы присвоено значение ).
|по желанию
|-
|value
|SettingsValue
|Значение настройки.

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

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

==== Объект <code>SettingsValue</code> ====
Значение настройки.

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

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

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

=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"schemaVersion": "1.0.0",
"updateToken": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
"insertAfter": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
"insertBefore": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
"value": {
"autoMonitoring": true
}
}</code>

== Ответ ==

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

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

==== Объект <code>SettingsObjectResponse</code> ====
Ответ на запрос на создание или обновление.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|invalidValue
|SettingsValue
|Значение настройки.

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

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

==== Объект <code>SettingsValue</code> ====
Значение настройки.

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

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

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

==== Объект <code>Error</code> ====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|constraintViolations
|ConstraintViolation[]
|Список нарушений ограничений
|-
|code
|integer
|Код состояния HTTP
|-
|message
|string
|Сообщение об ошибке
|}

==== Объект <code>ConstraintViolation</code> ====
Список нарушений ограничений
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|parameterLocation
|string
| -
Элемент может содержать эти значения

* <code>PATH</code>
* <code>PAYLOAD_BODY</code>
* <code>QUERY</code>
|-
|location
|string
| -
|-
|message
|string
| -
|-
|path
|string
| -
|}

=== JSON-модель тела ответа ===
<code>{
"invalidValue": {
"autoMonitoring": true
},
"objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
"code": 1,
"error": {
"constraintViolations": [
{
"parameterLocation": "PATH",
"location": "string",
"message": "string",
"path": "string"
}
],
"code": 1,
"message": "string"
}
}</code>

PUT объект - История изменений

IKuznetsov в 16:48, 2 января 2025

IKuznetsov в 10:29, 26 декабря 2024

ENetrebin: Новая страница: «Обновляет указанный объект настроек. Запрос создает и использует в качестве полезной н...»