Метод используется для обновления информации о шаблоне фильтров данных аналитики (см. Получение списка шаблонов фильтров).
PATCH {reseller_domain}/internal_api/user_templates/analytics/filters/{user_template_id}
В этой статье:
Авторизация
Требуется авторизация с помощью access token пользователя.
Аргументы
|
Название |
Тип параметра |
Тип данных |
Обязательный/
|
Описание |
||
|---|---|---|---|---|---|---|
|
Content-Type |
header |
string |
Обязательный |
Тип данных, передаваемых в запросе. Укажите application/vnd.api+json |
||
|
Accept |
header |
string |
Обязательный |
Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json |
||
|
X-Api-Locale |
header |
string |
Опциональный |
Двухбуквенный код языка данных в ответе и созданной асинхронной задачи |
||
|
Authorization |
header |
string |
Обязательный |
Действующий access token пользователя. Формат: |
||
|
reseller_domain |
path |
string |
Обязательный |
Доменное имя реселлера |
||
|
user_template_id |
path |
integer |
Обязательный |
ID шаблона фильтров |
||
|
name |
form |
string |
Обязательный |
Название шаблона фильтров |
||
|
filter_template |
form |
object |
Обязательный |
Параметры шаблона фильтров |
||
|
|
account_id |
form |
integer |
Опциональный |
ID аккаунта |
|
|
|
subscription_id |
form |
integer |
Опциональный |
ID подписки |
|
|
|
filters |
form |
array of objects |
Обязательный |
Список фильтров в шаблоне. Доступные фильтры и их параметры см. в Получение списка фильтров для аналитики |
|
|
|
|
key |
form |
string |
Обязательный |
Ключ фильтра |
|
|
|
type |
form |
string |
Обязательный |
Скоуп фильтра |
|
|
|
value |
form |
Зависит от фильтра |
Обязательный |
Установленные значения фильтра |
Модель ответа
Модель ответа аналогична методу Создание шаблона фильтров.
Пример запроса
curl --location --request PATCH 'https://test.activeplatform.com/internal_api/user_templates/analytics/filters/65' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample' \
--data '{
"data": {
"attributes": {
"name": "3rd-party resources+tags+Azure RI",
"filter_template": {
"account_id": 525,
"subscription_id": 2810,
"filters": [
{
"key": "category",
"type": "category",
"value": "3rd-party resources"
},
{
"key": "tags",
"type": "tags",
"value": [
"Purpose: POC OwnCloud"
]
},
{
"key": "reserved",
"type": "metadata",
"value": true
}
]
}
}
}
}'
Пример ответа
{
"data": {
"id": "65",
"type": "user_templates",
"attributes": {
"created_at": "2024-04-12T09:06:45.520+03:00",
"name": "3rd-party resources+tags+Azure RI",
"filter_template": {
"account_id": 525,
"subscription_id": 2810,
"filters": [
{
"key": "category",
"type": "category",
"value": "3rd-party resources"
},
{
"key": "tags",
"type": "tags",
"value": [
"Purpose: POC OwnCloud"
]
},
{
"key": "reserved",
"type": "metadata",
"value": true
}
]
}
}
},
"meta": {
"server_current_time": "2024-04-12T09:07:45.536814+0300"
}
}