Files

API Reference for ProcessMaker File API

Create or update a new setting

Create a new Settings css-override

post

/customize-ui

Authorizations

passportbearer

Body

variablesstring

sansSerifFontstring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/customize-ui' \
  --header 'Content-Type: application/json'

201

201

{
  "key": "text",
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": true,
  "readonly": true,
  "variables": "text",
  "sansSerifFont": "text",
  "config": [
    {}
  ],
  "id": "text",
  "created_at": "2025-02-20T19:04:30.142Z",
  "updated_at": "2025-02-20T19:04:30.142Z"
}

success

Returns the list of files

Display a listing of the resource.

get

/files

Authorizations

passportbearer

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionstring · enum · default: asc

Options: asc, desc

per_pageinteger · default: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/files'

200

200

{
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1,
    "sort_order": "asc"
  },
  "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-02-20T19:04:30.142Z",
      "updated_at": "2025-02-20T19:04:30.142Z"
    }
  ]
}

list of files

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

/files

Authorizations

passportbearer

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_namestring

Name of the variable used in a request

collectionstring

Media collection name. For requests, use 'default'

Body

filestring · binary

save a new media file

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/files?model_id=1&model=text' \
  --header 'Content-Type: multipart/form-data'

200

200

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

success

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

Get a single media file.

get

/files/{file_id}

Authorizations

passportbearer

Path parameters

file_idintegerrequired

ID of the file to return

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/files/{file_id}'

200

404

200

{
  "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-02-20T19:04:30.142Z",
  "updated_at": "2025-02-20T19:04:30.142Z"
}

Successfully found the file

Delete a media file

Remove the specified resource from storage.

delete

/files/{file_id}

Authorizations

passportbearer

Path parameters

file_idintegerrequired

ID of the file

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/1.0/files/{file_id}'

204

404

204

No body

success

Get the contents of a file

Display the specified resource.

get

/files/{file_id}/contents

Authorizations

passportbearer

Path parameters

file_idintegerrequired

ID of the file to return

Responses

application/octet-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/files/{file_id}/contents'

200

404

200

text

File stream