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-21T15:24:26Z

Новая страница: «'''''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|Развёртывание]] / Расширения 2.0 / Раширения / GET расширения'''''

Функция выводит список свойств указанного расширения Extensions 2.0 или загружает ZIP-файл расширения.

Запрос создает один из следующих типов полезной нагрузки, в зависимости от значения заголовка запроса Accept :
*<code>application/json</code>— полезная нагрузка JSON, содержащая свойства расширения.
*<code>application/octet-stream</code>— загрузка ZIP-файла расширения.
Если с запросом не предоставлен заголовок Accept<code>application/json</code> , возвращается полезная нагрузка.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/{extensionVersion}</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/{extensionVersion}</nowiki></code>
|}
==Аутентификация==
Чтобы выполнить этот запрос , вам нужен токен доступа с областью действия '''Read extensions''' ( <code>extensions.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|extensionName
|string
|Имя запрошенного расширения 2.0.
|path
|требуется
|-
|extensionVersion
|string
|Версия запрашиваемого расширения 2.0
|path
|требуется
|-
|Accept
|string
|Принять заголовок. Указывает часть расширения 2.0, которая будет возвращена:
*приложение/json; charset=utf-8 — возвращает метаданные расширения 2.0 в JSON
*application/octet-stream — возвращает zip-архив с расширением 2.0, хранящийся на сервере.
|заголовок
|по желанию
|}
==Ответ==
===Коды ответов===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|Extension
|Успех
|-
|404
|ErrorEnvelope
|Не удалось. Запрошенный ресурс не существует.
|-
|406
|ErrorEnvelope
|Неприемлимо
|}
===Объекты тела ответа===
====Объект <code>ResponseBody</code>====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|имя_расширения
|string
|Имя расширения
Может быть <code>null</code>.
|-
|version
|string
|Версия расширения
Может быть <code>null</code>.
|-
|author
|AuthorDto
|Автор расширения
Может быть <code>null</code>.
|-
|dataSources
|string[]
|Источники данных, которые расширение использует для сбора данных
Может быть <code>null</code>.
|-
|переменные
|string[]
|Пользовательские переменные, используемые в конфигурации расширения
Может быть <code>null</code>.
|-
|наборы функций
|string[]
|Доступные наборы функций
Может быть <code>null</code>.
|-
|featureSetsДетали
|object
|Подробная информация о наборах функций
Может быть <code>null</code>.
|-
|minAstromkeyVersion
|string
|Минимальная версия Ключ-АСТРОМ, которая работает с расширением
Может быть <code>null</code>.
|-
|fileHash
|string
|Хэш SHA-256 загруженного файла расширения
Может быть <code>null</code>.
|}
====Объект <code>AuthorDto</code>====
Автор расширения
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|name
|string
|Имя автора
Может быть <code>null</code>.
|}
====Объект <code>FeatureSetDetails</code>====
Дополнительная информация о наборе функций
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|metrics
|MetricDto[]
|Показатели набора функций
Может быть <code>null</code>.
|}
====Объект <code>MetricDto</code>====
Метрика, собранная расширением
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|key
|string
|Метрический ключ
Может быть <code>null</code>.
|-
|metadata
|MetricMetadataDto
|Метаданные показателей
Может быть <code>null</code>.
|}
====Объект <code>MetricMetadataDto</code>====
Метаданные показателей
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|displayName
|string
|Название метрики в пользовательском интерфейсе
Может быть <code>null</code>.
|-
|description
|string
|Краткое описание метрики
Может быть <code>null</code>.
|-
|unit
|string
|Единица измерения
Может быть <code>null</code>.
|}
===JSON-модель тела ответа===
<code>{
"extensionName": "string",
"version": "1.2.3",
"author": {
"name": "string"
},
"dataSources": [
"string"
],
"variables": [
"string"
],
"featureSets": [
"string"
],
"featureSetsDetails": {},
"minAstromkeyVersion": "string",
"fileHash": "string"
}</code>

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|Эндп...»