Files

Get file list

Get file list

GET/v1/files

Query parameters

Response

200400500

FileBody

Body

application/json

custom_messageany

dataany

descriptionstring

statusstring

dataobject_builder_service.GetAllFilesRequest (object)

Request

JavaScriptCurlPython

const response = await fetch('/v1/files', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "description": "text",
  "status": "text",
  "data": {
    "folder_name": "text",
    "project_id": "text",
    "search": "text",
    "sort": "text"
  }
}

Update file

Update file

PUT/v1/files

Body

application/json

UpdateFileRequestBody

descriptionstring

file_name_downloadstring

idstring

tagsarray of string

titlestring

Response

200400500

File data

Body

application/json

custom_messageany

dataany

descriptionstring

statusstring

dataobject_builder_service.File (object)

Request

JavaScriptCurlPython

const response = await fetch('/v1/files', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400500

{
  "description": "text",
  "status": "text",
  "data": {
    "description": "text",
    "file_name_disk": "text",
    "file_name_download": "text",
    "file_size": 0,
    "id": "text",
    "link": "text",
    "project_id": "text",
    "storage": "text",
    "tags": [
      "text"
    ],
    "title": "text"
  }
}

Delete files

Delete files

DELETE/v1/files

Body

application/json

DeleteFilesRequestBody

objectsarray of models.FileDelete (object)

Response

204400500

No Content

Request

JavaScriptCurlPython

const response = await fetch('/v1/files', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400500

{
  "description": "text",
  "status": "text",
  "data": "text"
}

Get single variable

Get single variable

GET/v1/files/{id}

Path parameters

id*string

id

Response

200400500

FileBody

Body

application/json

custom_messageany

dataany

descriptionstring

statusstring

dataobject_builder_service.File (object)

Request

JavaScriptCurlPython

const response = await fetch('/v1/files/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "description": "text",
  "status": "text",
  "data": {
    "description": "text",
    "file_name_disk": "text",
    "file_name_download": "text",
    "file_size": 0,
    "id": "text",
    "link": "text",
    "project_id": "text",
    "storage": "text",
    "tags": [
      "text"
    ],
    "title": "text"
  }
}

Delete file

Delete file

DELETE/v1/files/{id}

Path parameters

id*string

id

Response

204400500

No Content

Request

JavaScriptCurlPython

const response = await fetch('/v1/files/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400500

{
  "description": "text",
  "status": "text",
  "data": "text"
}