File API

Version: 2.7.0

Download a file by path

GET

/file/v2/orgs/{organisation_id}/workspaces/{workspace_id}/files/path/{file_path}

Request file metadata and a delegated download link for a specified file by path. The download link should be followed to download the file contents from blob storage. This link is pre-signed and will expire after 30 minutes. Set the include_versions query parameter to true to get the complete list of available versions. Set the version query parameter to request a download link for that specific version of the specified file. If version is not set, the latest version of the file will be returned.

Request

Path parameters

file_pathstring

Required

Examples: "a/b/file.txt", "a/new%20file.txt"

Path to the file.

organisation_iduuid

Required

Example: "00000000-0000-0000-0000-000000000000"

The customer's organisation organisation ID.

workspace_iduuid

Required

Example: "00000000-0000-0000-0000-000000000000"

The ID of the workspace in the organization.

Query parameters

version_idstring | null

Example: "1223372036854775807"

Optional version ID for the desired file version. By default, the response will return the latest version.

include_versionsboolean

Optional inclusion of the DownloadFile.versions. By default, the response will return versions as null.

Responses

200

An object containing file metadata and at least one download link. Optionally, the object will also contain a link for each file version.

Response schema

created_atdate-time

created_byobject | null

deleted_atstring | null

deleted_byobject | null

downloadstring

etagstring

file_iduuid

modified_atdate-time

modified_byobject | null

namestring

pathstring

selfstring

sizeinteger

version_idint64

versionsarray | null

400

/file-api/files/invalid-path

Invalid request path.

/file-api/bad-request

Bad request. The server cannot or will not process the request due to a client error.

Response schema

Any of:

InvalidPathErrorobject

detailstring | null

statusinteger

Default: 400

titlestring

Default: "Invalid Path."

typestring

Default: "https://seequent.com/error-codes/file-api/files/invalid-path"

BadRequestErrorobject

detailstring | null

statusinteger

Default: 400

titlestring

Default: "Bad Request."

typestring

Default: "https://seequent.com/error-codes/file-api/bad-request"

401

/file-api/auth/missing-token

Unauthorized. The client request has not been completed as the provided credentials are invalid.

/file-api/auth/invalid-token

Forbidden. The client credentials are valid but do not permit access to this resource.

Response schema

Any of:

MissingTokenErrorobject

detailstring | null

statusinteger

Default: 401

titlestring

Default: "Access Denied."

typestring

Default: "https://seequent.com/error-codes/file-api/auth/missing-token"

InvalidTokenErrorobject

detailstring | null

statusinteger

Default: 401

titlestring

Default: "Access Denied."

typestring

Default: "https://seequent.com/error-codes/file-api/auth/invalid-token"

403

/file-api/auth/insufficient-role

Forbidden. The client credentials are valid but the client does not have a sufficient role to access to this resource.

Response schema

detailstring | null

permitted_rolesarray

Default: []

statusinteger

Default: 403

titlestring

Default: "Insufficient Role."

typestring

Default: "https://seequent.com/error-codes/file-api/auth/insufficient-role"

your_rolestring

404

/file-api/files/not-found

File or version not found.

Response schema

detailstring | null

statusinteger

Default: 404

titlestring

Default: "File Not Found."

typestring

Default: "https://seequent.com/error-codes/file-api/files/not-found"

410

/file-api/files/gone

File has been deleted.

Response schema

detailstring | null

statusinteger

Default: 410

titlestring

Default: "The file has been deleted"

typestring

Default: "https://seequent.com/error-codes/file-api/files/gone"

422

/file-api/validation

The request was invalid and will not be processed due to a client error.

Response schema

detailstring | null

statusinteger

Default: 422

titlestring

Default: "Validation Error."

typestring

Default: "https://seequent.com/error-codes/file-api/validation"

500

/file-api/api-errors

A server error has occurred.

Response schema

detailstring | null

statusinteger

Default: 500

titlestring

Default: "An Error Occurred."

typestring

Default: "https://seequent.com/error-codes/file-api/api-errors"

502

/file-api/bad-gateway

Bad gateway. A response required to handle the request is invalid.

Response schema

detailstring | null

statusinteger

Default: 502

titlestring

Default: "Bad Gateway."

typestring

Default: "https://seequent.com/error-codes/file-api/bad-gateway"