18-04-2019 15:32

Получить информацию о файле

GET   {FS}/files/{customer_key}/filedata/{id}

Получение информации о файле по его ID

Эта операция требудет авторизации. Система ожидает передачи токена в переменной bsauth в заголовке, либо в GET/POST параметрах запроса

Запрос

GET https://file.brainysoft.ru/files/fastmoney/filedata/1
Описание параметров
Параметр Обязателен Тип данных Описание
customer_key R [ ] Код клиента BrainySoft, обязательный параметр
FS R [ ] URL файлового хранилища. Обмен данными с файловым хранилищем Брейнисофт происходит по НТTP протоколу и используется стандартный порт. Пример параметра FS выглядит следующим образом  http://file.company.ru:80.
id R [ ] ID файла

Ответ


                        {
  "status": "ok",
  "timestamp": 1491917181000,
  "data": {
    "id": 2,
    "fileName": "Test.pdf",
    "fileDesc": "",
    "iconUrl": "https://files.bs.dev/icon/pdf.png",
    "thumbUrl": "https://files.bs.dev/icon/pdf.png",
    "fileUrl": "https://files.bs.dev/file/fastmoney/original/2f50203235a6fc770f0263dc8673c9df235274fb7",
    "connections": {
      "lead": 1840,
      "client": null,
      "loanapp": null,
      "contract": null,
      "collateral": null,
      "sharecontract": null,
      "depositcontract": null,
      "dds": null,
      "comment": null
    },
    "downloadCount": 1,
    "updateCount": 0,
    "tags": [],
    "fileSize": 916137,
    "size": "895 Kb"
  }
}
Описание параметров
Параметр Обязателен Тип данных Описание
created_at R [timestamp] Дата загрузки файла в файловое хранилище. Метка времени UNIX в секундах
size R [string][100] Размер файла в байтах
fileSize R [int] Размер файла, пригодный для демонтрации пользователю (в Кб или Мб в зависимости от размера файла)
updateCount R [int] Количесто обновлений файла
downloadCount R [int] Количество скачиваний
connections R [object] Массив связей файла с сущностями системы
connections.contract R [int] Привязка к контракту. В случае отсуствия привязки файла к этой сущности - возвращается null
connections.collateral R [int] Привязка к залогу. В случае отсуствия привязки файла к этой сущности - возвращается null
connections.sharecontract R [int] Привязка к паю. В случае отсуствия привязки файла к этой сущности - возвращается null
connections.depositcontract R [int] Привязка к депозиту. В случае отсуствия привязки файла к этой сущности - возвращается null
connections.dds R [int] Привязка к ДДС. В случае отсуствия привязки файла к этой сущности - возвращается null
connections.comment R [int] Привязка к комментарию. В случае отсуствия привязки файла к этой сущности - возвращается null
connections.loanapp R [int] Привязка к заявке. В случае отсуствия привязки файла к этой сущности - возвращается null
connections.client R [int] Привязка к клиенту. В случае отсуствия привязки файла к этой сущности - возвращается null
connections.lead R [int] Привязка к лиду. В случае отсуствия привязки файла к этой сущности - возвращается null
fileUrl R [string][1024] Ссылка на файл
iconUrl R [string][1024] Ссылка на иконку файла
id R [int] ID файла в системе
fileName R [string][255] Им файла на момент загрузки в систему
fileDesc R [string][255] Описание файла
tags R [collection] Массив идентификаторов категорий файлов. Возвращает элементы типа [int]
thumbUrl R [string][1024] Ссылка на маленькую копию файла (в слуае картинкии - это уменьшенное изображение)