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



BasePath:/services/files/

Access

Methods

[ Jump to Models ]

Table of Contents

Default

Default

Up
get /download/{nodeId}/{version}
(downloadNode)
Downloads a specific version of a node

Path parameters

nodeId (required)
Path Parameter — The id of the node to download format: uuid
version (required)
Path Parameter — The version of the node to download

Return type

NodeBinary

Example data

Content-Type: application/json
{
  "file" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The node to download NodeBinary

400

The request was malformed

403

The access to the resource is denied

404

The resource was not found

Up
get /download/{nodeId}
(downloadNodeLastVersion)
Downloads the last version of a node

Path parameters

nodeId (required)
Path Parameter — The id of the node to download format: uuid

Return type

NodeBinary

Example data

Content-Type: application/json
{
  "file" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The node to download NodeBinary

400

The request was malformed

403

The access to the resource is denied

404

The resource was not found

Up
get /health
(health)
Check the status of the service and its dependencies.

Responses

204

The service is up & running

500

The service is not available

Up
get /link/{linkId}
(linkDownload)
Download the node associated to the specific link

Path parameters

LinkId (required)
Path Parameter — The id of the existing link

Return type

NodeBinary

Example data

Content-Type: application/json
{
  "file" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The node to download NodeBinary

400

The request was malformed

403

The access to the resource is denied

404

The resource was not found

Up
post /upload
(uploadNode)
Uploads a new node

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Object (optional)
Body Parameter — New node data, content type header must be specified based on the file to upload

Request headers

Return type

CreatedNode

Example data

Content-Type: application/json
{
  "nodeId" : "nodeId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The data of the new created node CreatedNode

400

The request was malformed

403

The access to the resource is denied

404

The resource was not found

Up
post /upload-version
(uploadNodeVersion)
Uploads a new version of an existing node

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Object (optional)
Body Parameter — New node data, content type header must be specified based on the file to upload

Request headers

Return type

CreatedNodeVersion

Example data

Content-Type: application/json
{
  "nodeId" : "nodeId",
  "version" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The data of the new node version CreatedNodeVersion

400

The request was malformed

403

The access to the resource is denied

404

The resource was not found

Models

[ Jump to Methods ]

Table of Contents

  1. CreatedNode
  2. CreatedNodeVersion
  3. NodeBinary

CreatedNode Up

nodeId (optional)
String format: UUID

CreatedNodeVersion Up

nodeId (optional)
String format: UUID
version (optional)

NodeBinary Up

file (optional)
byte[] format: binary