GET всех свойств события
API Ключ-АСТРОМ / Эндпойнты среды / Развёртывание / События v2 / GET всех свойств события
Список всех свойств событий, предоставляемых Ключ-АСТРОМ.
Запрос создает application/json
полезную нагрузку.
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/eventProperties
|
Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventProperties
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение событий ( events.read
) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
nextPageKey | string | Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey . Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса. |
запрос | необязательный |
pageSize | integer | Количество свойств события в полезной нагрузке одного ответа.
Максимально допустимый размер страницы – 500. Если не установлено, используется 100. |
запрос | необязательный |
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | EventPropertyDetail | Успех |
Объекты тела ответа
Объект EventPropertyDetails
Список свойств события.
Элемент | Тип | Описание |
---|---|---|
eventProperties | EventPropertyDetail[] | Список свойств события.
Может быть |
pageSize | integer | Количество записей на странице.
Может быть |
nextPageKey | string | Курсор для следующей страницы результатов. Имеет значение null на последней странице.
Используйте его в параметре запроса nextPageKey для получения последующих страниц результата. Может быть |
totalCount | integer | Общее количество записей в результате. |
Объект EventPropertyDetail
Конфигурация свойства события.
Элемент | Тип | Описание |
---|---|---|
displayName | string | Отображаемое имя свойства события.
Может быть |
writable | boolean | Указывает, может ли свойство быть установлено во время приема события.
Может быть |
key | string | Ключ свойства события.
Может быть |
description | string | Краткое описание свойства события.
Может быть |
JSON-модель тела ответа
{
"eventProperties": [
{
"displayName": "Custom description",
"writable": true,
"key": "dt.event.description",
"description": "string"
}
],
"pageSize": 1,
"nextPageKey": "AQAAABQBAAAABQ==",
"totalCount": 1
}
Пример
В этом примере в запросе перечислены все доступные свойства событий, доступные в среде mySampleEnv . Результат усекается до трех записей
Маркер API передается в заголовке авторизации .
Curl
curl --request GET \
--url 'https://mySampleEnv.live.ruscomtech.com/api/v2/eventProperties?pageSize=3' \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.com/api/v2/eventProperties?pageSize=3
Тело ответа
{
"totalCount": 23,
"pageSize": 3,
"nextPageKey": "AQAAAAMBAAAAAw==",
"eventProperties": [
{
"key": "dt.event.allow_ai_merge",
"displayName": "Allow AI merge",
"description": "Allow AI to merge this event into existing problems (true) or force creating a new problem (false)",
"writable": true
},
{
"key": "dt.event.baseline.service_method",
"displayName": "Baseline affected service method",
"description": "Lists affected service methods of the triggered service event",
"writable": false
},
{
"key": "dt.event.baseline.total_load",
"displayName": "Baseline total load",
"description": "The load (calls per minute) of the entire service or application for triggered event",
"writable": false
}
]
}
Код ответа
200