ENetrebin: Новая страница: «'''''API Ключ-АСТРОМ / API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндп...»

2024-06-17T16:40:03Z

Новая страница: «'''''API Ключ-АСТРОМ / API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндп...»

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

'''''[[API Ключ-АСТРОМ]] / [[API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндпойнты среды]] / [[API Ключ-АСТРОМ#.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|Развёртывание]] / События v2 / GET всех свойств события'''''

Список всех свойств событий, предоставляемых Ключ-АСТРОМ.

Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/eventProperties</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventProperties</nowiki></code>
|}
==Аутентификация==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение событий ( <code>events.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|nextPageKey
|string
|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey .

Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.
|запрос
|необязательный
|-
|pageSize
|integer
|Количество свойств события в полезной нагрузке одного ответа.
Максимально допустимый размер страницы – 500.

Если не установлено, используется 100.
|запрос
|необязательный
|}
==Ответ==
===Коды ответов===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|EventPropertyDetail
|Успех
|}
===Объекты тела ответа===
====Объект <code>EventPropertyDetails</code>====
Список свойств события.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|eventProperties
|EventPropertyDetail[]
|Список свойств события.
Может быть <code>null</code>.
|-
|pageSize
|integer
|Количество записей на странице.
Может быть <code>null</code>.
|-
|nextPageKey
|string
|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.
Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.

Может быть <code>null</code>.
|-
|totalCount
|integer
|Общее количество записей в результате.
|}
====Объект <code>EventPropertyDetail</code>====
Конфигурация свойства события.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|displayName
|string
|Отображаемое имя свойства события.
Может быть <code>null</code>.
|-
|writable
|boolean
|Указывает, может ли свойство быть установлено во время приема события.
Может быть <code>null</code>.
|-
|key
|string
|Ключ свойства события.
Может быть <code>null</code>.
|-
|description
|string
|Краткое описание свойства события.
Может быть <code>null</code>.
|}
===JSON-модель тела ответа===
<code>{
"eventProperties": [
{
"displayName": "Custom description",
"writable": true,
"key": "dt.event.description",
"description": "string"
}
],
"pageSize": 1,
"nextPageKey": "AQAAABQBAAAABQ==",
"totalCount": 1
}</code>
==Пример==
В этом примере в запросе перечислены все доступные свойства событий, доступные в среде mySampleEnv . Результат усекается до трех записей

Маркер API передается в заголовке авторизации .
====Curl====
<code>curl --request GET \
--url '<nowiki>https://mySampleEnv.live.ruscomtech.com/api/v2/eventProperties?pageSize=3'</nowiki> \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
====URL-адрес запроса====
<code><nowiki>https://mySampleEnv.live.ruscomtech.com/api/v2/eventProperties?pageSize=3</nowiki></code>
====Тело ответа====
<code>{
"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
}
]
}</code>
====Код ответа====
200

GET всех свойств события - История изменений

ENetrebin: Новая страница: «'''''API Ключ-АСТРОМ / API Ключ-АСТРОМ#.D0.AD.D0.BD.D0.B4.D0.BF.D0.BE.D0.B9.D0.BD.D1.82.D1.8B%20.D1.81.D1.80.D0.B5.D0.B4.D1.8B|Эндп...»