File API

Version: 2.10.0

Delete a file by path

DELETE

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

Request to delete a file. This will delete the file and all historic versions.

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.

Responses

204

The file has been deleted.

400

/file-api/bad-request

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

Response schema

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": "Bad Request.",
  "type": "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"

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 deleting the specified file.

/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"
}