File API

List folder contents

GET

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

Request to list files. The maximum number of results returned is limited to 5000.

Request

Path parameters

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

limitinteger

Default: 5000

The number of results to return.

offsetinteger

The number of results to skip.

deletedboolean

When true, only files that have been deleted will be returned

authorstring | null

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

The ID of the author to filter on.

file_namestring | null

>= 1 char

Example: "drilling_data"

The name of the file to filter on. Will perform a case insensitive partial match, so the query file_name=gold will match a file with the name allgoldcolumns.csv.

created_atarray | null

Example: "gte:2023-03-10T22:56:53Z"

A date or dates (max 2) to filter files by. Dates may contain operator prefixes, in the form <operator>:<datetime>. The following operators are available (lt=less than, lte=less than or equal to, gt=greater than, gte=greater than or equal to).If you omit the operator, then it is assumed the operator is 'equal to'. In this case you may only supply one date. The dates must also be in a valid ISO 8601 format.Dates may include a UTC offset. If the offset is omitted, the timezone is assumed to be UTC.

modified_bystring | null

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

The ID of the last person to modify the file to filter on.

modified_atarray | null

Example: "gte:2023-03-10T22:56:53Z"

deleted_bystring | null

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

The UUID of the user that deleted a file

deleted_atarray | null

Example: "gte:2023-03-10T22:56:53Z"

order_bystring

Example: "order_by=modified_at,desc:created_at"

A comma separated list of fields to order by, where the default sort order is ascending. To specify the sort order, prefix the field name with either asc: or desc: for ascending or descending respectively. Field names can be one of the following known sort fields: created_at, modified_at, deleted_at

Responses

200

A list of files

Response schema

countinteger

filesobject[]

created_atdate-time

created_byobject | null

deleted_atstring | null

deleted_byobject | null

etagstring

file_iduuid

linksListFileLinks

Optional

selfstring

modified_atdate-time

modified_byobject | null

namestring

pathstring

sizeinteger

version_idint64

limitinteger

linksListFilesResponseLinks

nextstring | null

prevstring | null

selfstring

offsetinteger

totalinteger

Example response

{
  "count": 0,
  "files": [
    {
      "created_at": "2024-07-29T15:51:28.071Z",
      "created_by": {
        "email": "string",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string"
      },
      "deleted_at": "2024-07-29T15:51:28.071Z",
      "deleted_by": {
        "email": "string",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string"
      },
      "etag": "string",
      "file_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "links": {
        "self": "string"
      },
      "modified_at": "2024-07-29T15:51:28.071Z",
      "modified_by": {
        "email": "string",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string"
      },
      "name": "string",
      "path": "string",
      "size": 0,
      "version_id": "string"
    }
  ],
  "limit": 0,
  "links": {
    "next": "string",
    "prev": "string",
    "self": "string"
  },
  "offset": 0,
  "total": 0
}

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"

Example response

{
  "detail": "string",
  "status": 400,
  "title": "Invalid Path.",
  "type": "https://seequent.com/error-codes/file-api/files/invalid-path"
}

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"

Example response

{
  "detail": "string",
  "status": 401,
  "title": "Access Denied.",
  "type": "https://seequent.com/error-codes/file-api/auth/missing-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

Example response

{
  "detail": "string",
  "permitted_roles": [
    null
  ],
  "status": 403,
  "title": "Insufficient Role.",
  "type": "https://seequent.com/error-codes/file-api/auth/insufficient-role",
  "your_role": "string"
}

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"

Example response

{
  "detail": "string",
  "status": 422,
  "title": "Validation Error.",
  "type": "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"

Example response

{
  "detail": "string",
  "status": 500,
  "title": "An Error Occurred.",
  "type": "https://seequent.com/error-codes/file-api/api-errors"
}

502 /file-api/metadata/store-error

A database error occurred when listing files.

/file-api/bad-gateway

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

Response schema

Any of:

MetadataStoreErrorobject

detailstring | null

statusinteger

Default: 502

titlestring

Default: "File Metadata Storage Operation Failed."

typestring

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

BadGatewayobject

detailstring | null

statusinteger

Default: 502

titlestring

Default: "Bad Gateway."

typestring

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

Example response

{
  "detail": "string",
  "status": 502,
  "title": "File Metadata Storage Operation Failed.",
  "type": "https://seequent.com/error-codes/file-api/metadata/store-error"
}