Метод «file — работа с файлами»

Что умеет:

  • Получает информацию о файле, хранящемся в поле пользовательской таблицы (GET-запрос)

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

Запрос

GET {URL-аккаунта}/api/dev/file/{ID-таблицы}/{ID-поля}/{ID-записи}?filename={Название-файла}

Замените {URL-аккаунта} на URL экземпляра КБ, например, https://demo.clientbase.ru или http://localhost:8080/.
Замените {ID-таблицы} на идентификатор таблицы.
Заменить {ID-поля} на идентификатор поля таблицы, содержащего файл.
Замените {ID-записи} на идентификатор записи в таблице, содержащей файл.
Замените {Название-файла} на название файла. Если параметр указан, будет возвращена информация по указанному файлу. Если параметр не указан, будет возвращена информация по всем файлам.
Значения для замены можно посмотреть в левом нижнем углу при наведение мышки на название файла.

img-2025-07-07-14-00-50

Заголовки

При вызове метода укажите заголовки:

Content-Type: application/vnd.api+json  
X-Auth-Token: Ваш-токен

Для получения токена пройдите авторизацию.

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

curl -X GET
-H 'Content-Type: application/vnd.api+json' \
-H 'X-Auth-Token: pevj1MaRq5qTUifWQ4iwVe7AcSfpGgiSCyu4T8hMfydX0Tew' \
'https://apitest.clientbase.ru/api/dev/file/130/5941/85/?filename=Коммерческое предложение для Роман.pdf'

Ответ

"data": {
        "name": "Коммерческое предложение для Роман.pdf",
        "id": "Коммерческое предложение для Роман.pdf",
        "content": "JVBERi0xLjQKJeLjz9MKMyAwIG9iag .. QolJUVPRg==", // Содержимое файла в кодировке base64
        "md5sum": "3e7fc440d951ef4740c3f54d8f8e65ca"  // md5 от содержимого файла (для проверки корректности передачи данных) 
    }
}

Формат ответа

200 OK (application/vnd.api+json)
либо ошибка

image: mail