Перейти к основному содержимому

Загрузка файлов API 1.7.0

Методы API для работы с разделом «Загрузка файлов».

Базовый путь: https://{IP_контроллера}/api/v1. Версия описания API: 1.7.0.

Примеры используют placeholder-значения для паролей, token, UUID, адресов и секретов. Перед выполнением запроса замените их на значения вашего контроллера.

Методы раздела​

МетодПуть
POST/group_update/upload

POST /group_update/upload​

Раздел: Загрузка файлов.

Загрузка прошивки для группового обновления

Источник в Teamly

Назначение

URL запроса

Загрузка прошивки для группового обновления

https://{IP_контроллера}/api/v1/group_update/upload

Параметры запроса:

Название

Тип

Описание

upload*

object(body)

Тело запроса

BODY

Название

* - обязательный

Тип

Формат

Назначение

update_file *

string

$binary

Файл прошивки в бинарном виде

Пример:

URL запроса: POST
https://{IP_контроллера}/api/v1/group_update/upload

Body

Пример из Teamly сохранён дословно, но не является корректным JSON.

{
  { 
  'update_file=@STR_ALM_5.1_1.2.1.bin;type=application/octet-stream'
}
}

Варианты ответа:

Code 200 (File uploaded) - удачное выполнение запроса

{
  "filePath": "string"
}

Code 400 (Bad request parameters) - запрос не выполнен, неверно указаны параметры запроса

Code 500 (Unexpected server error) - запрос не выполнен, получено сообщение об ошибке

Параметры и ответы по OpenAPI
{
  "description": "Загрузка прошивки",
  "requestBody": {
    "required": true,
    "content": {
      "multipart/form-data": {
        "schema": {
          "type": "object",
          "required": [
            "update_file"
          ],
          "properties": {
            "update_file": {
              "type": "string",
              "format": "binary",
              "description": "Firmware file"
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "File uploaded",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "filePath": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Bad request parameters",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Server error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI​

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса​

curl -k -X POST "https://{IP_контроллера}/api/v1/group_update/upload" \
  -H "Authorization: Bearer <token>" \
  --form 'update_file=@/path/to/update_file;type=application/octet-stream'

Пример ответа​

{
  "filePath": "string"
}