GET всех расширений

Материал из Документация Ключ-АСТРОМ

Функция возвращает список всех расширений Extensions 2.0, доступных в вашей среде Ключ-АСТРОМ .

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

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

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

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

Параметры

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

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

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

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

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

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

запрос по желанию
name string Фильтрует полученный набор расширений 2.0 по имени. Вы можете указать частичное имя. В этом случае используется оператор CONTAINS. запрос по желанию

Ответ

Коды ответов

Код Тип Описание
200 Список расширений Успех

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

Объект ResponseBody

Элемент Тип Описание
pageSize 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=="
}