POST файла расширения

Материал из Документация Ключ-АСТРОМ
Версия от 15:36, 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 / Раширения / POST файла расширения

Данная функция загружает файл расширения Extensions 2.0 в вашу среду Ключ-АСТРОМ.

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

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

minAstromkeyVersion 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": {},
  "minAstromkeyVersion": "string",
  "fileHash": "string"
}