POST файла расширения: различия между версиями

Версия от 13:21, 24 декабря 2024

API АппОптима / Эндпойнты среды / Развёртывание / Расширения 2.0 / Расширения / POST файла расширения

Данная функция загружает файл расширения Extensions 2.0 в вашу среду АппОптима.

Запрос потребляет multipart/form-dataполезную нагрузку и создает application/jsonполезную нагрузку.

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

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

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

Параметры

Параметр	Тип	Описание	In	Необходимость
File	zip.file	Файл пакета расширения 2.0 ( `*.zip`) для загрузки. Должен содержать только расширение `zip`и `.zip.sig`файлы.	body	требуется

Ответ

Коды ответов

Код	Тип	Описание
200	Extension	Расширение действительно
201	Extension	Успех. Расширение 2.0 загружено.
400	ErrorEnvelope	Не удалось. Входной файл недействителен.
409	ErrorEnvelope	Загрузка пока невозможна, повторите попытку через несколько секунд.

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

Объект `ResponseBody`

Элемент	Тип	Описание
extensionName	string	Имя расширения Может быть `null`.
version	string	Версия расширения Может быть `null`.
author	AuthorDto	Автор расширения Может быть `null`.
dataSources	string[]	Источники данных, которые расширение использует для сбора данных Может быть `null`.
variables	string[]	Пользовательские переменные, используемые в конфигурации расширения Может быть `null`.
featureSets	string[]	Доступные наборы функций Может быть `null`.
featureSetsDetails	object	Подробная информация о наборах функций Может быть `null`.
minAppOptimaVersion	string	Минимальная версия АппОптима, которая работает с расширением Может быть `null`.
fileHash	string	Хэш SHA-256 загруженного файла расширения Может быть `null`.

Объект `AuthorDto`

Автор расширения

Элемент	Тип	Описание
name	string	Имя автора Может быть `null`.

Объект `FeatureSetDetails`

Дополнительная информация о наборе функций

Элемент	Тип	Описание
показатели	MetricDto[]	Показатели набора функций Может быть `null`.

Объект `MetricDto`

Метрика, собранная расширением

Элемент	Тип	Описание
key	string	Ключ метрики Может быть `null`.
metadata	MetricMetadataDto	Метаданные показателей Может быть `null`.

Объект `MetricMetadataDto`

Метаданные показателей

Элемент	Тип	Описание
displayName	string	Название метрики в пользовательском интерфейсе Может быть `null`.
description	string	Краткое описание метрики Может быть `null`.
unit	string	Единица измерения Может быть `null`.

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

<{
  "extensionName": "string",
  "version": "1.2.3",
  "author": {
    "name": "string"
  },
  "dataSources": [
    "string"
  ],
  "variables": [
    "string"
  ],
  "featureSets": [
    "string"
  ],
  "featureSetsDetails": {},
  "minAppOptimaVersion": "string",
  "fileHash": "string"
}

@@ Строка 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 / Раширения / POST файла расширения'''''
+'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [[API АппОптима#:~:text=DELETE тегов-,Развёртывание,-править|Развёртывание]] / [[API АппОптима#:~:text=GET свойства события-,Расширения 2.0,-Конфигурации среды|Расширения 2.0]] / [[API АппОптима#:~:text=GET списка событий-,Расширения,-GET всех расширений|Расширения]] / POST файла расширения'''''
-Данная функция загружает файл расширения Extensions 2.0 в вашу среду Ключ-АСТРОМ.
+Данная функция загружает файл расширения Extensions 2.0 в вашу среду АппОптима.
 Запрос потребляет <code>multipart/form-data</code>полезную нагрузку и создает <code>application/json</code>полезную нагрузку.
 {| class="wikitable"
 | rowspan="2" |POST
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions</nowiki></code>
 |-
@@ Строка 93: / Строка 93: @@
 Может быть <code>null</code>.
 |-
-|minAstromkeyVersion
+|minAppOptimaVersion
 |string
-|Минимальная версия Ключ-АСТРОМ, которая работает с расширением
+|Минимальная версия АппОптима, которая работает с расширением
 Может быть <code>null</code>.
 |-
@@ Строка 167: / Строка 167: @@
 |}
 ===JSON-модель тела ответа===
-  <code>{
+  <{
     "extensionName": "string",
     "version": "1.2.3",
@@ Строка 183: / Строка 183: @@
     ],
     "featureSetsDetails": {},
-    "minAstromkeyVersion": "string",
+    "minAppOptimaVersion": "string",
     "fileHash": "string"
   }</code>