Skip to content

Latest commit

 

History

History
116 lines (72 loc) · 3.48 KB

AttachmentsApi.md

File metadata and controls

116 lines (72 loc) · 3.48 KB
Raw

AttachmentsApi

All URIs are relative to http://localhost

Method HTTP request Description
apiV2AttachmentsIdDelete DELETE /api/v2/attachments/{id} Delete attachment file
apiV2AttachmentsIdGet GET /api/v2/attachments/{id} Download attachment file
apiV2AttachmentsOccupiedFileStorageSizeGet GET /api/v2/attachments/occupiedFileStorageSize Get size of attachments storage in bytes
apiV2AttachmentsPost POST /api/v2/attachments Upload new attachment file

apiV2AttachmentsIdDelete

apiV2AttachmentsIdDelete(id)

Delete attachment file

Parameters

Name Type Description Notes
id UUID [default to null]

Return type

null (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

apiV2AttachmentsIdGet

File apiV2AttachmentsIdGet(id, width, height, resizeType, backgroundColor, preview)

Download attachment file

Parameters

Name Type Description Notes
id UUID [default to null]
width Integer Width of the result image [optional] [default to null]
height Integer Height of the result image [optional] [default to null]
resizeType ImageResizeType Type of resizing to apply to the result image [optional] [default to null] [enum: Crop, AddBackgroundStripes]
backgroundColor String Color of the background if the `resizeType` is `AddBackgroundStripes` [optional] [default to null]
preview Boolean If image must be converted to a preview (lower quality, no animation) [optional] [default to null]

Return type

File

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

apiV2AttachmentsOccupiedFileStorageSizeGet

Long apiV2AttachmentsOccupiedFileStorageSizeGet()

Get size of attachments storage in bytes

Parameters

This endpoint does not need any parameter.

Return type

Long

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

apiV2AttachmentsPost

AttachmentModel apiV2AttachmentsPost(file)

Upload new attachment file

File size is restricted to 50 MB (52 428 800 bytes)

Parameters

Name Type Description Notes
file File [optional] [default to null]

Return type

AttachmentModel

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json