Дата последней модификации страницы: 19.09.2024

Методы группы files внешнего программного интерфейса менеджера сервиса предназначены для выполнения различных служебных действий с файлами.

Сводка по методам

МетодНазначение
files/complete_multipartЗавершить составную загрузку
files/infoИнформация о файле
files/new_multipartНачать составную загрузку
files/new_partСделать новую часть
files/abort_multipartОтменить составную загрузку

files/complete_multipart

Завершить составную загрузку

ПараметрТипОписаниеПример
Запрос
file_idСтрока переменная (36)Идентификатор файла85bb388c-1517-11ea-6d94-0242ac130033
partsМассив из Строка неограниченной длиныЧасти["0c78aef83f66abc1fa1e8477f296d394"]
Ответ
Нет параметров
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/srv/files/complete_multipart
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "file_id": "85bb388c-1517-11ea-6d94-0242ac130033",
  "parts": [
    "0c78aef83f66abc1fa1e8477f296d394"
  ]
}
Пример ответа  Развернуть 
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

files/info

Информация о файле

ПараметрТипОписаниеПример
Запрос
file_idСтрока переменная (36)Идентификатор файла85bb388c-1517-11ea-6d94-0242ac130033
scope *Массив из Строка (перечисление)Параметры получения данных:
  • data_dump_info (Получать информацию из файла архивной копии)
["data_dump_info"]
Ответ: file (1)
ownerЧисло (7.0)Владелец файла123
nameСтрока переменная (255)Имя файлаdata_dump.zip
size *Число (+15.0)Размер файла12345
data_dump_info *
Информация из содержимого файла архивной копии
  - conf_name *Строка переменная (255)Имя конфигурации, как оно задано в конфигуратореРаботаВМоделиСервиса
  - conf_presentation *Строка переменная (64)Имя конфигурации.РаботаВМоделиСервиса
  - apptype_presentation *Строка переменная (150)Наименование вида приложенияРабота в модели сервиса
  - apptype_id *Строка переменная (22)Код вида приложенияmt
  - app_version *Строка переменная (18)Версия конфигурации1.1.3.10
  - usersСписок (0..*)Пользователи из архивной копии
  - users.loginСтрока переменная (50)Логин пользователяAbramov
  - users.name *Строка переменная (150)Полное имя пользователяАбрамов Геннадий Сергеевич
  - users.user_id *Уникальный идентификаторИдентификатор пользователя из архивной копииabf7c2a7-1df7-4646-9327-2866804b6ce2
  - extensionsСписок (0..*)Расширения из архивной копии
  - extensions.idСтрока переменная (260)Имя расширенияМоеРасширение
  - extensions.descriptionСтрока переменная (100)Наименование расширенияМое расширение
  - extensions.versionСтрока переменная (18)Версия расширения1.0.0.1
  - extensions.version_uuidУникальный идентификаторИдентификатор версии расширенияabf7c2a7-1df7-4646-9327-2866804b6ce2
  - extensions.changes_data_structureБулевоРасширение расширяет данныеtrue
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/srv/files/info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "file_id": "85bb388c-1517-11ea-6d94-0242ac130033",
  "scope": [
    "data_dump_info"
  ]
}
Пример ответа  Развернуть 
{
  "file": {
    "owner": 123,
    "name": "data_dump.zip",
    "size": 12345,
    "data_dump_info": {
      "conf_name": "РаботаВМоделиСервиса",
      "conf_presentation": "РаботаВМоделиСервиса",
      "apptype_presentation": "Работа в модели сервиса",
      "apptype_id": "mt",
      "app_version": "1.1.3.10",
      "users": [
        {
          "login": "Abramov",
          "name": "Абрамов Геннадий Сергеевич",
          "user_id": "abf7c2a7-1df7-4646-9327-2866804b6ce2"
        }
      ],
      "extensions": [
        {
          "id": "МоеРасширение",
          "description": "Мое расширение",
          "version": "1.0.0.1",
          "version_uuid": "abf7c2a7-1df7-4646-9327-2866804b6ce2",
          "changes_data_structure": true
        }
      ]
    }
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

files/new_multipart

Начать составную загрузку

ПараметрТипОписаниеПример
Запрос
nameСтрока неограниченной длиныИмя файлаdata_dump.zip
size *Число (+15.0)Размер файла123456798
typeСтрока (перечисление)Тип файла:
  • new_data_dump (Выгрузка данных для создания приложения)
  • tenant_backup (Резервная копия области)
tenant_backup
owner *Число (7.0)Владелец файла: для резервных копий (tenant_backup) это номер области, для выгрузок для создания приложения (new_data_dump) это код абонента123
Ответ
file_idСтрока переменная (36)Идентификатор файла85bb388c-1517-11ea-6d94-0242ac130033
urlСтрока неограниченной длиныАдресhttps://backups.example.ru/00/89/2b/85bb388c-1517-11ea-6d94-0242ac130033
typeСтрока неограниченной длиныТип адреса - dt или s3s3
headersСписок (0..*)Заголовки для запроса["x-header-1: value1"]
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/srv/files/new_multipart
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "name": "data_dump.zip",
  "size": 123456798,
  "type": "tenant_backup",
  "owner": 123
}
Пример ответа  Развернуть 
{
  "file_id": "85bb388c-1517-11ea-6d94-0242ac130033",
  "url": "https://backups.example.ru/00/89/2b/85bb388c-1517-11ea-6d94-0242ac130033",
  "type": "s3",
  "headers": [
    "x-header-1: value1"
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

files/new_part

Сделать новую часть

ПараметрТипОписаниеПример
Запрос
file_idСтрока переменная (36)Идентификатор файла85bb388c-1517-11ea-6d94-0242ac130033
part_numberЧисло (3.0)Номер части1
Ответ
urlСтрока неограниченной длиныАдресhttps://backups.example.ru/00/89/2b/85bb388c-1517-11ea-6d94-0242ac130033
typeСтрока неограниченной длиныТип адреса - dt или s3s3
headersСписок (0..*)Заголовки для запроса["x-header-1: value1"]
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/srv/files/new_part
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "file_id": "85bb388c-1517-11ea-6d94-0242ac130033",
  "part_number": 1
}
Пример ответа  Развернуть 
{
  "url": "https://backups.example.ru/00/89/2b/85bb388c-1517-11ea-6d94-0242ac130033",
  "type": "s3",
  "headers": [
    "x-header-1: value1"
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

files/abort_multipart

Отменить составную загрузку

ПараметрТипОписаниеПример
Запрос
file_idСтрока переменная (36)Идентификатор файла85bb388c-1517-11ea-6d94-0242ac130033
Ответ
Нет параметров
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/srv/files/abort_multipart
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "file_id": "85bb388c-1517-11ea-6d94-0242ac130033"
}
Пример ответа  Развернуть 
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх