18-04-2019 15:29

Получение списка файлов

GET   {FS}/files/{customer_key}/list

Метод для получения списка файлов

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

Запрос

GET https://file.brainysoft.ru/files/fastmoney/list?lead=3143
Описание параметров
Параметр Обязателен Тип данных Описание
FS R [ ] URL файлового хранилища. Обмен данными с файловым хранилищем Брейнисофт происходит по НТTP протоколу и используется стандартный порт. Параметр FS для запроса в файловое хранилище Брейнисофт выглядит следующим образом  http://file.brainysoft.ru:80.
customer_key R [string] Код клиента BrainySoft, обязательный параметр
lead R [int] ID лида, к которому привязан файл
client R [int] ID клиента, к которому привязан файл
loanapp R [int] ID заявки, к которой привязан файл
contract R [int] ID контракта, к которому привязан файл
collateral R [int] ID залога, к которому привязан файл
sharecontract R [int] ID паевого контракта, к которому привязан файл
depositcontract R [int] ID депозита, к которому привязан файл
dds R [int] ID ДДС, к которому привязан файл
comment R [int] ID коммментария, к которому привязан файл
tag R [int]

ID категории (тэга)
ext R [string] фильтр по расширению файла (LIKE %%)
name R [string] фильтр по имени файла (по имени файла, который загружали)
desc R [string] фильтр по описанию файла (его указывали, когда закгружали файл)
skip R [int] сколько элементов пропустить при выдаче списка
take R [int] сколько элементов показать
qty R [string] если флаг передан = 1, метод возвражает количество элементов
order R [string] название поля по которому нужно делать сортироку. По умолчанию сортировка делается по правилу 'desc' (от меньшего к большему)
orderdest R [enum]

Возможные значения:

  • desc - от меньшего к большему
  • asc - от большего к меньшему

По умолчанию применяется правило desc
boolean R [string] Можно передать значение OR или значение AND. По умолчанию все фильтры применяются по принципу AND (то есть показываются файлы, удовлетворяющие всем указанным условиям, но можно показывать файлы, где встречается любое из указанных условий фильтрации). По умолчанию, если переменная не указана ее значение принимается = AND

Ответ


                        {
    "status": "ok",
    "timestamp": 1526973752000,
    "data": [
        {
            "id": "788",
            "fileName": "Согласие на обработку персональных данных (из ЛК).pdf",
            "fileDesc": "",
            "iconUrl": "https://file.brainysoft.ru/icon/pdf.png",
            "thumbUrl": "https://file.brainysoft.ru/icon/pdf.png",
            "fileUrl": "https://file.brainysoft.ru/file/o/698551013fcee702812336fb6f52d1a748c3d876bd000dd9fc1fdba4fe0714a4823287fe34899652",
            "connections": {
                "lead": "3143",
                "client": "101321410",
                "loanapp": null,
                "contract": null,
                "collateral": null,
                "sharecontract": null,
                "depositcontract": null,
                "dds": null,
                "comment": null
            },
            "downloadCount": 0,
            "updateCount": 0,
            "created_at": "1526909166",
            "tags": [
                "24"
            ],
            "fileSize": "344618",
            "size": "337 Kb"
        }
    ]
}
Описание параметров
Параметр Обязателен Тип данных Описание
connections R [object] Массив связей файла с сущностями системы
connections.lead R [int] Привязка к лиду. В случае отсуствия привязки файла к этой сущности - возвращается null
connections.client R [int] Привязка к клиенту. В случае отсуствия привязки файла к этой сущности - возвращается null
connections.loanapp R [int] Привязка к заявке. В случае отсуствия привязки файла к этой сущности - возвращается null
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
downloadCount R [int] Количество скачиваний
updateCount R [int] Количесто обновлений файла
fileSize R [int] Размер файла, пригодный для демонтрации пользователю (в Кб или Мб в зависимости от размера файла)
size R [string][100] Размер файла в байтах
created_at R [timestamp] Дата загрузки файла в файловое хранилище. Метка времени UNIX в секундах
id R [int] ID файла в системе
fileName R [string][255] Им файла на момент загрузки в систему
fileDesc R [string][255] Описание файла
tags R [collection]

Массив идентификаторов категорий файлов. Возвращает элементы типа [int] 
iconUrl R [string][1024] Ссылка на иконку файла
thumbUrl R [string][1024] Ссылка на маленькую копию файла (в слуае картинкии - это уменьшенное изображение)
fileUrl R [string][1024] Ссылка на файл