API docs by Redocly

Files API (latest)

Download OpenAPI specification:

Files API to upload, download blobs and to retrieve a link of a specific node.

Preview

Get image preview

Creates and returns a preview of the image fetched by id and optionally by version with the given size, quality and format

  • nodeId: UUID of the image
  • version: version of the image
  • quality: quality of the output image (the higher you go the slower the process)
  • output_format: format of the output image
  • area: width of the output image (>=0) x height of the output image (>=0), width x height => 100x200. The first is width, the latter height, the order is important!
  • crop: True will crop the picture starting from the borders. This option will lose information, leaving it False will scale and have borders to fill the requested size.
path Parameters
nodeId
required
string (Id)
area
required
string (Area)
query Parameters
version
integer (Version)
quality
string (ImageQualityEnum)
Default: "medium"
Enum: "lowest" "low" "medium" "high" "highest"

Class representing all the image quality accepted values

output_format
string (ImageTypeEnum)
Default: "medium"
Enum: "jpeg" "png"

Class representing all the image type accepted values

crop
boolean (Crop)
Default: false

Responses

Get image thumbnail

Creates and returns a preview of the image fetched by id and optionally by version with the given size, quality and format

  • nodeId: UUID of the image
  • version: version of the image
  • quality: quality of the output image (the higher you go the slower the process)
  • output_format: format of the output image
  • area: width of the output image (>=0) x height of the output image (>=0), width x height => 100x200. The first is width, the latter height, the order is important!
  • shape: Rounded and Rectangular are currently supported.
path Parameters
nodeId
required
string (Id)
area
required
string (Area)
query Parameters
version
integer (Version)
quality
string (ImageQualityEnum)
Default: "medium"
Enum: "lowest" "low" "medium" "high" "highest"

Class representing all the image quality accepted values

output_format
string (ImageTypeEnum)
Default: "medium"
Enum: "jpeg" "png"

Class representing all the image type accepted values

shape
string (ImageShapeEnum)
Default: "Rectangular"
Enum: "Rounded" "Rectangular"

Class representing all the image shape accepted values

Responses

Get pdf preview

Creates and returns a preview of the pdf fetched by id and optionally by version, the pdf file will contain the first and last page given. With default values it will return a pdf with all the pages.

  • nodeId: UUID of the pdf
  • version: version of the pdf
  • first_page: integer value of first page to preview (n>=1)
  • last_page: integer value of last page to preview (0 = last of the original pdf)
path Parameters
nodeId
required
string (Id)
query Parameters
version
integer (Version)
first_page
integer (FirstPage)
last_page
integer (LastPage)

Responses

Get pdf thumbnail

Creates and returns a preview of the image fetched by id and optionally by version with the given size, quality and format

  • nodeId: UUID of the pdf
  • version: version of the pdf
  • quality: quality of the output image (the higher you go the slower the process)
  • output_format: format of the output image
  • area: width of the output image (>=0) x height of the output image (>=0), width x height => 100x200. The first is width, the latter height, the order is important!
  • shape: Rounded and Rectangular are currently supported.
path Parameters
nodeId
required
string (Id)
area
required
string (Area)
query Parameters
version
integer (Version)
quality
string (ImageQualityEnum)
Default: "medium"
Enum: "lowest" "low" "medium" "high" "highest"

Class representing all the image quality accepted values

output_format
string (ImageTypeEnum)
Default: "medium"
Enum: "jpeg" "png"

Class representing all the image type accepted values

shape
string (ImageShapeEnum)
Default: "Rectangular"
Enum: "Rounded" "Rectangular"

Class representing all the image shape accepted values

Responses

Get document preview

Creates and returns a preview of the document fetched by id and optionally by version, the pdf file will contain the first and last page given. With default values it will return a pdf with all the pages.

  • nodeId: UUID of the pdf
  • version: version of the pdf
  • first_page: integer value of first page to preview (n>=1)
  • last_page: integer value of last page to preview (0 = last of the original pdf)
path Parameters
nodeId
required
string (Id)
query Parameters
version
integer (Version)
first_page
integer (FirstPage)
last_page
integer (LastPage)

Responses

health

Check the status of the service and its dependencies.

Responses

downloadNodeLastVersion

Downloads the last version of a node

path Parameters
nodeId
required
string <uuid>

The id of the node to download

Responses

checkDownloadNodeLastVersion

Preliminary check for downloading the last version of a node

path Parameters
nodeId
required
string <uuid>

The id of the node to download

Responses

downloadNode

Downloads a specific version of a node

path Parameters
nodeId
required
string <uuid>

The id of the node to download

version
required
integer

The version of the node to download

Responses

downloadMultipleNodes

Downloads multiple nodes by their IDs

Request Body schema: application/x-www-form-urlencoded
required
nodeIds
required
string

JSON stringified array of node IDs

Responses

checkDownloadMultipleNodes

Preliminary check for downloading multiple nodes by their IDs

Request Body schema: application/json
required
nodeIds
required
Array of strings

Array of node IDs

Responses

Request samples

Content type
application/json
{
  • "nodeIds": [
    ]
}

uploadNode

Uploads a new node

header Parameters
Filename
required
string

The fullname of the file to upload encoded in Base64

Description
string <byte>

The description of the file to upload

ParentId
string <UUID>

The id of the folder where to upload the file, if omitted it will be uploaded on user Home

Request Body schema: application/octet-stream

New node data, content type header must be specified based on the file to upload

string <binary>

Responses

Response samples

Content type
application/json
{
  • "nodeId": "string"
}

uploadNodeInternal

Uploads a new node (internal call without token verification)

header Parameters
Filename
required
string

The fullname of the file to upload encoded in Base64

Description
string <byte>

The description of the file to upload

ParentId
string <UUID>

The id of the folder where to upload the file, if omitted it will be uploaded on user Home

AccountId
required
string

The id of the account where to upload the file

Request Body schema: application/octet-stream

New node data, content type header must be specified based on the file to upload

string <binary>

Responses

Response samples

Content type
application/json
{
  • "nodeId": "string"
}

uploadNodeVersion

Uploads a new version of an existing node

header Parameters
NodeId
required
string <UUID>

The id of the existing node

Filename
required
string <byte>

The fullname of the node to upload encoded in Base64

OverwriteVersion
required
boolean

If true the current version of the node is overwritten by the new one, otherwise a new version is created

Request Body schema: application/octet-stream

New node data, content type header must be specified based on the file to upload

string <binary>

Responses

Response samples

Content type
application/json
{
  • "nodeId": "string",
  • "version": 0
}

uploadTo

Requests to upload a specific file to a specific target module

header Parameters
NodeId
required
string <UUID>

The id of the existing node

Filename
required
string <byte>

The fullname of the node to upload encoded in Base64

OverwriteVersion
required
boolean

If true the current version of the node is overwritten by the new one, otherwise a new version is created

Request Body schema: application/octet-stream

New node data, content type header must be specified based on the file to upload

string <binary>

Responses

Response samples

Content type
application/json
{
  • "nodeId": "string",
  • "version": 0
}