GET всех расширений - Расширения: различия между версиями

Версия от 14:51, 21 июня 2024

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

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

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

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

@@ Строка 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|Развёртывание]] / Расширения 2.0 / Раширения / GET всех расширений'''''
 Функция возвращает список всех расширений Extensions 2.0, доступных в вашей среде Ключ-АСТРОМ .
@@ Строка 20: / Строка 21: @@
 !Описание
 !In
-!Необходимый
+!Необходимость
 |-
 |nextPageKey