Файл архива ролевого приложения (attachment)

Запросы

HTTP verb Endpoint Описание

GET

/rest/v1/domain/roleapps/<id>/attachment

Скачивание файла

PUT

/rest/v1/domain/roleapps/<id>/attachment

Заливка нового файла

DELETE

/rest/v1/domain/roleapps/<id>/attachment

Удаление файла

HEAD

/rest/v1/domain/roleapps/<id>/attachment

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


Скачивание файла

Запрос

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/domain/roleapps/68f99ca9-016c-d352-e02f-50e54938780c/attachment HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/octet-stream; charset=utf-8
Content-Disposition: attachment; filename*=UTF-8''Web%20Application%201.zip

BINARY BODY OF 'Web Application 1.zip'

Заливка нового файла

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

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

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

Запрос

Пример запроса (octet-stream)
PUT /rest/v1/domain/roleapps/68f99ca9-016c-d352-e02f-50e54938780c/attachment HTTP/1.1
Content-Type: application/octet-stream

BINARY BODY OF 'app.zip'
Пример запроса (multipart)
PUT /rest/v1/domain/roleapps/68f99ca9-016c-d352-e02f-50e54938780c/attachment 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.zip"
Content-Transfer-Encoding: binary

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

Ответ

Пример ответа
HTTP/1.1 204 No Content

Удаление файла

Запрос

Пример запроса
DELETE /rest/v1/domain/roleapps/68f99ca9-016c-d352-e02f-50e54938780c/attachment HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 204 No Content

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

Возвращает мета-информацию о файле, содержащую в том числе размер в заголовке Content-Length.

Особенности

  • HTTP-ответ не содержит тела, несмотря на наличие заголовка Content-Length.

Запрос

Пример запроса
HEAD /rest/v1/domain/roleapps/4bfe3429-016d-0d12-cade-e0d55e0cd303/attachment?attachment=true HTTP/1.1

Ответ

Пример успешного ответа
HTTP/1.1 200 OK
Content-Type: application/octet-stream
Content-Disposition: attachment; filename=roleapp_4bfe3429-016d-0d12-cade-e0d55e0cd303.zip
Content-Length: 25389
Пример неуспешного ответа
HTTP/1.1 404 Not Found