GET свойства события

API Ключ-АСТРОМ / Эндпойнты среды / Развёртывание / События v2 / GET свойства события

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

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

GET	Managed	https://{your-domain}/e/{your-environment-id}/api/v2/eventProperties/{propertyKey}
	Среда АктивногоШлюза	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