ENetrebin (обсуждение | вклад) (Новая страница: «Назначает пользовательские теги указанному приложению. Вам нужно только указать значен...») |
Нет описания правки |
||
(не показана 1 промежуточная версия этого же участника) | |||
Строка 6: | Строка 6: | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="2" |POST | | rowspan="2" |POST | ||
| | |АппОптима | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/applications/{meIdentifier}</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/applications/{meIdentifier}</nowiki></code> | ||
|- | |- | ||
Строка 26: | Строка 26: | ||
|meIdentifier | |meIdentifier | ||
|string | |string | ||
|Идентификатор объекта | |Идентификатор объекта АппОптима для приложения, которое вы хотите обновить. | ||
|path | |path | ||
|требуется | |требуется | ||
Строка 32: | Строка 32: | ||
|body | |body | ||
|UpdateEntity | |UpdateEntity | ||
|Список тегов, которые должны быть назначены объекту | |Список тегов, которые должны быть назначены объекту АппОптима. | ||
|body | |body | ||
|по желанию | |по желанию | ||
Строка 40: | Строка 40: | ||
==== Объект <code>UpdateEntity</code> ==== | ==== Объект <code>UpdateEntity</code> ==== | ||
Список тегов, которые должны быть назначены объекту | Список тегов, которые должны быть назначены объекту АппОптима. | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
Строка 49: | Строка 49: | ||
|tags | |tags | ||
|string [] | |string [] | ||
|Список тегов, которые должны быть назначены объекту | |Список тегов, которые должны быть назначены объекту АппОптима. | ||
|требуется | |требуется | ||
|} | |} | ||
Строка 55: | Строка 55: | ||
=== JSON-модель тела запроса === | === JSON-модель тела запроса === | ||
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. | Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. | ||
< | <{ | ||
"tags": [ | "tags": [ | ||
"office-linz", | "office-linz", | ||
"office-klagenfurt" | "office-klagenfurt" | ||
] | ] | ||
} | } | ||
== Ответ == | == Ответ == | ||
Строка 85: | Строка 85: | ||
==== Curl ==== | ==== Curl ==== | ||
< | <curl -X POST \ | ||
<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/applications/MOBILE_APPLICATION-752C288D59734C79</nowiki> \ | <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/applications/MOBILE_APPLICATION-752C288D59734C79</nowiki> \ | ||
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \ | -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \ | ||
Строка 94: | Строка 94: | ||
"Android app" | "Android app" | ||
] | ] | ||
}' | }' | ||
==== URL-адрес запроса ==== | ==== URL-адрес запроса ==== | ||
Строка 100: | Строка 100: | ||
==== Тело запроса ==== | ==== Тело запроса ==== | ||
< | <{ | ||
"tags": [ | "tags": [ | ||
"iOS app", | "iOS app", | ||
"Android app" | "Android app" | ||
] | ] | ||
} | } | ||
==== Код ответа ==== | ==== Код ответа ==== | ||
204 | 204 |
Текущая версия от 14:05, 26 декабря 2024
Назначает пользовательские теги указанному приложению. Вам нужно только указать значение тега. Контекст CONTEXTLESS
будет назначен автоматически.
Использование этого API ограничено тегами только со значениями. Чтобы назначить теги ключ:значение, используйте API пользовательских тегов .
Запрос потребляет application/json
полезную нагрузку.
POST | АппОптима | https://{your-domain}/e/{your-environment-id}/api/v1/entity/applications/{meIdentifier}
|
Cреда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/applications/{meIdentifier}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( DataExport
) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
meIdentifier | string | Идентификатор объекта АппОптима для приложения, которое вы хотите обновить. | path | требуется |
body | UpdateEntity | Список тегов, которые должны быть назначены объекту АппОптима. | body | по желанию |
Объекты тела запроса
Объект UpdateEntity
Список тегов, которые должны быть назначены объекту АппОптима.
Элемент | Тип | Описание | Необходимость |
---|---|---|---|
tags | string [] | Список тегов, которые должны быть назначены объекту АппОптима. | требуется |
JSON-модель тела запроса
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<{ "tags": [ "office-linz", "office-klagenfurt" ] }
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
204 | Успех. Параметры приложения были обновлены. | |
400 | ErrorEnvelope | Не удалось. Ввод недействителен. |
Пример
В этом примере запрос присваивает теги iOS-приложение и Android -приложение демо - приложению easyTravel с идентификатором MOBILE_APPLICATION-752C288D59734C79 .
Маркер API передается в заголовке авторизации .
Curl
<curl -X POST \ https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/applications/MOBILE_APPLICATION-752C288D59734C79 \ -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \ -H 'Content-Type: application/json' \ -d '{ "tags": [ "iOS app", "Android app" ] }'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/applications/MOBILE_APPLICATION-752C288D59734C79
Тело запроса
<{ "tags": [ "iOS app", "Android app" ] }
Код ответа
204