Вложенный файл, тип свойства 'attachment' (на примере класса 'abc/mnesia' и свойства 'patt')

Содержание

Обзор
Запросы

Обзор

Позволяет приложить к сущности файл-вложение с размещением на диске в преднастроенном хранилище, связанным с коллекцией класса.
И в дальнейшем производить операции чтения, замены, удаления вложения.

Каждое свойство типа `attachment` формирует в REST-API отдельный endpoint этого типа.

Файл после загрузки теряет имя и расширение, и доступен к скачиванию с потерей этих характеристик под именем `content`.

Допустимо заливать файл с content-type application/octet-stream и multipart/form-data. В последнем случае фактически сохраняется первый из списка файлов.

Реальный путь к вложениям формируется одинаково вне зависимости от типа хранилища:
Для категорий: `…/Domain/ClassName/Id12/Id34/Id56/IdRest/PropertyName`
Для истории: `…/Domain/ClassName/Id12/Id34/Id56/IdRest/PropertyName`

Запросы

HTTP verb Endpoint Описание

HTTP verb	Endpoint	Описание
`GET`	`/rest/v1/model/model/<classname>/<id>/<attachment_property>`	Скачивание вложения
`PUT`	`/rest/v1/model/<classname>/<id>/<attachment_property>`	Заливка вложения
`DELETE`	`/rest/v1/model/<classname>/<id>/<attachment_property>`	Удаление вложения

GET

/rest/v1/model/model/<classname>/<id>/<attachment_property>

Скачивание вложения

PUT

/rest/v1/model/<classname>/<id>/<attachment_property>

Заливка вложения

DELETE

/rest/v1/model/<classname>/<id>/<attachment_property>

Удаление вложения

Скачивание вложения

Запрос

Table 1. Параметры запроса
Имя	Тип	Описание
`attachment`	`bool`	Тип выдачи. По умолчанию `false`. `true` – выдаётся с заголовком `Content-Disposition: attachment; filename=filename.ext` либо `Content-Disposition: attachment; filename*=UTF-8''%d1%84%d0%b0%d0%b9%d0%bb.ext`, где `файл.ext` – имя файла в кодировке UTF-8 и URLencoded. `false` – выдается без заголовка `Content-Disposition`.

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

GET /rest/v1/model/abc/mnesia/68f99ca9-016c-d352-e02f-50e54938780c/patt HTTP/1.1

Ответ

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

HTTP/1.1 200 OK
Content-Type: application/octet-stream; charset=utf-8
Content-Disposition: attachment; filename*=UTF-8''Some%20file.mp3

BINARY BODY OF 'Some file.mp3'

Заливка вложения

Производит замену файла.

Загрузка одного файла производится либо с помощью Content-Type: multipart/formdata, либо с произвольным Content-Type не являющимся мультипартом.

Если загрузка происходит с Content-Type: multipart/formdata, то будет сохранён только первый файл (первая часть имеющая поле filename в заголовке Content-Disposition), а само название файла будет проигнорировано.

Запрос

Пример запроса (octet-stream)

PUT /rest/v1/model/abc/mnesia/68f99ca9-016c-d352-e02f-50e54938780c/patt HTTP/1.1
Content-Type: application/octet-stream

BINARY BODY OF 'app.mp3'

Пример запроса (multipart)

PUT /rest/v1/model/abc/mnesia/68f99ca9-016c-d352-e02f-50e54938780c/patt HTTP/1.1
Content-Type: multipart/form-data; boundary=-----------boundary_69df8120352a996e

-----------boundary_69df8120352a996e
Content-Type: application/octet-stream
Content-Disposition: form-data; name="abcde"; filename="app.mp3"
Content-Transfer-Encoding: binary

BINARY BODY OF 'app.mp3'
-----------boundary_69df8120352a996e--

Ответ

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

HTTP/1.1 204 No Content

Удаление вложения

Запрос

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

DELETE /rest/v1/model/abc/mnesia/68f99ca9-016c-d352-e02f-50e54938780c/patt HTTP/1.1

Ответ

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

HTTP/1.1 204 No Content