processmaker.com Knowledge Center ProcessMaker University

Files

API Reference for ProcessMaker File API

PreviousEnvironment Variables NextNotifications

Last updated 4 months ago

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

get

Get a single media file.

Authorizations

Path parameters

file_idintegerRequired

ID of the file to return

Responses

200

Successfully found the file

application/json

Responseall of

and

404

Not Found

application/json

get

GET /api/1.0/files/{file_id} HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "model_id": 1,
  "model_type": "text",
  "collection_name": "text",
  "name": "text",
  "file_name": "text",
  "mime_type": "text",
  "disk": "text",
  "size": 1,
  "manipulations": {},
  "custom_properties": {},
  "responsive_images": {},
  "order_column": 1,
  "created_at": "2025-05-01T04:56:32.636Z",
  "updated_at": "2025-05-01T04:56:32.636Z"
}

Delete a media file

delete

Remove the specified resource from storage.

Authorizations

Path parameters

file_idintegerRequired

ID of the file

Responses

204

success

404

Not Found

application/json

delete

DELETE /api/1.0/files/{file_id} HTTP/1.1
Host: 
Accept: */*

No content

Get the contents of a file

get

Display the specified resource.

Authorizations

Path parameters

file_idintegerRequired

ID of the file to return

Responses

200

File stream

application/octet-stream

Responsestring · binary

404

Not Found

application/json

get

GET /api/1.0/files/{file_id}/contents HTTP/1.1
Host: 
Accept: */*

binary

Returns the list of files

get

Display a listing of the resource.

Authorizations

Query parameters

filterstringOptional

Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

order_bystringOptional

Field to order results by

order_directionstring · enumOptionalDefault: ascPossible values:

per_pageintegerOptionalDefault: 10

Responses

200

list of files

application/json

get

GET /api/1.0/files HTTP/1.1
Host: 
Accept: */*

200

list of files

{
  "data": [
    {
      "id": 1,
      "model_id": 1,
      "model_type": "text",
      "collection_name": "text",
      "name": "text",
      "file_name": "text",
      "mime_type": "text",
      "disk": "text",
      "size": 1,
      "manipulations": {},
      "custom_properties": {},
      "responsive_images": {},
      "order_column": 1,
      "created_at": "2025-05-01T04:56:32.636Z",
      "updated_at": "2025-05-01T04:56:32.636Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Create or update a new setting

post

Create a new Settings css-override

Authorizations

Body

variablesstringOptional

sansSerifFontstringOptional

Responses

201

success

application/json

Responseall of

post

POST /api/1.0/customize-ui HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "variables": "text",
  "sansSerifFont": "text"
}

201

success

{
  "key": "text",
  "config": [
    {}
  ],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": true,
  "readonly": true,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-05-01T04:56:32.636Z",
  "updated_at": "2025-05-01T04:56:32.636Z"
}

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

post

Store a newly created resource in storage.

Authorizations

Query parameters

model_idintegerRequired

ID of the model to which the file will be associated

modelstringRequired

Full namespaced class of the model to associate

data_namestringOptional

Name of the variable used in a request

collectionstringOptional

Media collection name. For requests, use 'default'

Body

filestring · binaryOptional

save a new media file

Responses

200

success

application/json

post

POST /api/1.0/files?model_id=1&model=text HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

200

success

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