GET свойства события: различия между версиями

Версия от 12:52, 24 декабря 2024

API АппОптима / Эндпойнты среды / Развёртывание / События v2 / GET свойства события

Получает сведения о свойстве события.

Запрос создает application/jsonполезную нагрузку.

GET	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v2/eventProperties/{propertyKey}`
GET	Среда АктивногоШлюза	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/eventProperties/{propertyKey}`

Аутентификация

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение событий ( events.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр	Тип	Описание	In	Необходимость
свойствоКлюч	string	Ключ свойства события, который вы запрашиваете.	path	обязательный

Ответ

Коды ответов

Код	Тип	Описание
200	Сведения о свойстве события	Успех

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

Объект `EventPropertyDetail`

Конфигурация свойства события.

Элемент	Тип	Описание
отображаемое имя	string	Отображаемое имя свойства события. Может быть `null`.
доступный для записи	boolean	Указывает, может ли свойство быть установлено во время приема события. Может быть `null`.
ключ	string	Ключ свойства события. Может быть `null`.
описание	string	Краткое описание свойства события. Может быть `null`.

JSON-модель тела ответа

<{
  "displayName": "Custom description",
  "writable": true,
  "key": "dt.event.description",
  "description": "string"
}

Пример

В этом примере запрос запрашивает сведения о свойстве пользовательского источника события.

Маркер API передается в заголовке авторизации .

Curl

<curl --request GET \
  --url 'https://mySampleEnv.live.ruscomtech.com/api/v2/eventProperties/dt.event.source' \
  --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

URL-адрес запроса

https://mySampleEnv.live.ruscomtech.com/api/v2/eventProperties/dt.event.source

Тело ответа

<{
  "key": "dt.event.source",
  "displayName": "Custom source",
  "description": "The name or ID of the external source of the event",
  "writable": true
}

Код ответа

200

@@ Строка 1: / Строка 1: @@
-'''''[[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 свойства события'''''
+'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [[API АппОптима#:~:text=DELETE тегов-,Развёртывание,-править|Развёртывание]] / [[API АппОптима#:~:text=развертывания из Jenkins-,События v2,-GET списка событий|События v2]] / GET свойства события'''''
 Получает сведения о свойстве события.
@@ Строка 6: / Строка 6: @@
 {| class="wikitable"
 | rowspan="2" |GET
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/eventProperties/{propertyKey}</nowiki></code>
 |-
@@ Строка 68: / Строка 68: @@
 |}
 ===JSON-модель тела ответа===
-  <code>{
+  <{
     "displayName": "Custom description",
     "writable": true,
@@ Строка 79: / Строка 79: @@
 Маркер API передается в заголовке авторизации .
 ====Curl====
-  <code>curl --request GET \
+  <curl --request GET \
     --url '<nowiki>https://mySampleEnv.live.ruscomtech.com/api/v2/eventProperties/dt.event.source'</nowiki> \
     --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
@@ Строка 85: / Строка 85: @@
   <code><nowiki>https://mySampleEnv.live.ruscomtech.com/api/v2/eventProperties/dt.event.source</nowiki></code>
 ====Тело ответа====
-  <code>{
+  <{
     "key": "dt.event.source",
     "displayName": "Custom source",