Files

API Reference for ProcessMaker File API

Create or update a new setting

Create a new Settings css-override

POST/api/1.0/customize-ui

Body

application/json

variablesstring

sansSerifFontstring

Response

201

success

Body

application/json

keystring

Class Settings

configarray of object

namestring

helperstring

groupstring

formatstring

hiddenboolean

readonlyboolean

variablesstring

sansSerifFontstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/customize-ui', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "key": "text",
  "config": [],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": false,
  "readonly": false,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2024-11-16T08:02:23.170Z",
  "updated_at": "2024-11-16T08:02:23.170Z"
}

Returns the list of files

Display a listing of the resource.

GET/api/1.0/files

Query parameters

Response

200

list of files

Body

application/json

dataarray of media (object)

metametadata (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "model_type": "text",
      "collection_name": "text",
      "name": "text",
      "file_name": "text",
      "mime_type": "text",
      "disk": "text",
      "created_at": "2024-11-16T08:02:23.170Z",
      "updated_at": "2024-11-16T08:02:23.170Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}

Save a new media file. Note: To upload files to a request, use createRequestFile in the RequestFile API

Store a newly created resource in storage.

POST/api/1.0/files

Query parameters

Body

multipart/form-data

filestring (binary)

save a new media file

Response

200

success

Body

application/json

idstring

model_idstring

file_namestring

mime_typestring

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/files?model=text', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "model_id": "text",
  "file_name": "text",
  "mime_type": "text"
}

Get the metadata of a file. To actually fetch the file see Get File Contents

Get a single media file.

GET/api/1.0/files/{file_id}

Path parameters

file_id*integer

ID of the file to return

Response

200404

Successfully found the file

Body

application/json

idinteger (id)

Represents media files stored in the database

model_idinteger (id)

model_typestring (id)

collection_namestring

namestring

file_namestring

mime_typestring

diskstring

sizeinteger

manipulationsobject

custom_propertiesobject

responsive_imagesobject

order_columninteger

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurlPython

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

Response

200404

{
  "model_type": "text",
  "collection_name": "text",
  "name": "text",
  "file_name": "text",
  "mime_type": "text",
  "disk": "text",
  "created_at": "2024-11-16T08:02:23.170Z",
  "updated_at": "2024-11-16T08:02:23.170Z"
}

Delete a media file

Remove the specified resource from storage.

DELETE/api/1.0/files/{file_id}

Path parameters

file_id*integer

ID of the file

Response

204404

success

Request

JavaScriptCurlPython

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

Response

404

{
  "error": "text"
}

Get the contents of a file

Display the specified resource.

GET/api/1.0/files/{file_id}/contents

Path parameters

file_id*integer

ID of the file to return

Response

200404

File stream

Body

application/octet-stream

string (binary)

Request

JavaScriptCurlPython

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

Response

200404

binary