Download a card file

GET

/boards/{board}/cards/{card}/files/{file}/download

const url = 'https://projects.work.optidata.cloud/api/boards/1/cards/1/files/example/download';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://projects.work.optidata.cloud/api/boards/1/cards/1/files/example/download \
  --header 'Authorization: Bearer <token>'

Streams the file content from Optiwork Drive as an attachment download.

Authorizations

bearerAuth

Parameters

Path Parameters

board

required

integer

Board id.

card

required

integer

Card id (must belong to the board).

file

required

string

File identifier (opaque string, not the numeric id).

Responses

200

The file content (Content-Disposition attachment).

application/octet-stream

string format: binary

401

Missing, invalid or expired bearer passport.

application/json

object

error

string

Example

{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

The authenticated user lacks the required board permission.

application/json

object

message

string

Example

{
  "message": "This action is unauthorized."
}

404

Resource not found, or a nested resource does not belong to its parent in the path.

application/json

object

message

string

Example

{
  "message": "Not found."
}