GET версии расширения

Материал из Документация Ключ-АСТРОМ
Версия от 15:16, 21 июня 2024; 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|Эндп...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

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

Функция возвращает список всех версий указанного расширения Extensions 2.0.

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

GET Managed https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}
Среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}

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

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

Параметры

Параметр Тип Описание In Необходимость
nextPageKey string Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.

Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey .

Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.

запрос по желанию
pageSize integer Количество расширений в полезной нагрузке одного ответа.

Максимально допустимый размер страницы — 100.

Если не установлено, используется 20.

запрос по желанию
extensionName string Имя запрошенного расширения 2.0. path требуется

Ответ

Коды ответов

Код Тип Описание
200 ExtensionList Успех
404 ErrorEnvelope Не удалось. Запрошенный ресурс не существует.

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

Объект ResponseBody

Элемент Тип Описание
extensions MinimalExtension[] Список расширений.

Может быть null.

totalCount integer Общее количество записей в результате.
pageSize integer Количество записей на странице.

Может быть null.

nextPageKey string Курсор для следующей страницы результатов. Имеет значение nullна последней странице.

Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.

Может быть null.

Объект MinimalExtension

Список расширений.

Элемент Тип Описание
extensionName string Имя расширения

Может быть null.

version string Версия расширения

Может быть null.

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

{
  "extensions": [
    {
      "extensionName": "string",
      "version": "1.2.3"
    }
  ],
  "totalCount": 1,
  "pageSize": 1,
  "nextPageKey": "AQAAABQBAAAABQ=="
}