processmaker.com Knowledge Center ProcessMaker University

Requests

API Reference for ProcessMaker Request API

PreviousGroups NextTasks

Last updated 3 months ago

Was this helpful?

Get single process request by ID

get

Display the specified resource.

Authorizations

Path parameters

process_request_idintegerrequired

ID of process request to return

Query parameters

includestring · default: ""optional

Include data from related models in payload. Comma separated list.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/requests/{process_request_id}'

200

404

{
  "user_id": "text",
  "callable_id": "text",
  "data": {},
  "status": "ACTIVE",
  "name": "text",
  "process_id": "text",
  "process": {},
  "id": "text",
  "process_collaboration_id": "text",
  "participant_id": "text",
  "process_category_id": "text",
  "created_at": "2025-03-22T00:20:11.338Z",
  "updated_at": "2025-03-22T00:20:11.338Z",
  "user": null,
  "participants": [
    {
      "email": "name@gmail.com",
      "firstname": "text",
      "lastname": "text",
      "username": "text",
      "password": "text",
      "address": "text",
      "city": "text",
      "state": "text",
      "postal": "text",
      "country": "text",
      "phone": "text",
      "fax": "text",
      "cell": "text",
      "title": "text",
      "timezone": "text",
      "datetime_format": "text",
      "language": "text",
      "is_administrator": true,
      "expires_at": "text",
      "loggedin_at": "text",
      "remember_token": "text",
      "status": "ACTIVE",
      "fullname": "text",
      "avatar": "text",
      "media": [
        {
          "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-03-22T00:20:11.338Z",
          "updated_at": "2025-03-22T00:20:11.338Z"
        }
      ],
      "birthdate": "2025-03-22",
      "delegation_user_id": "text",
      "manager_id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "force_change_password": true,
      "id": 1,
      "created_at": "2025-03-22T00:20:11.338Z",
      "updated_at": "2025-03-22T00:20:11.338Z",
      "deleted_at": "2025-03-22T00:20:11.338Z"
    }
  ]
}

Successfully found the process

Delete a process request

delete

Delete a request

Authorizations

Path parameters

process_request_idintegerrequired

ID of process request to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/1.0/requests/{process_request_id}'

204

404

{
  "user_id": "text",
  "callable_id": "text",
  "data": {},
  "status": "ACTIVE",
  "name": "text",
  "process_id": "text",
  "process": {},
  "id": "text",
  "process_collaboration_id": "text",
  "participant_id": "text",
  "process_category_id": "text",
  "created_at": "2025-03-22T00:20:11.338Z",
  "updated_at": "2025-03-22T00:20:11.338Z",
  "user": null,
  "participants": [
    {
      "email": "name@gmail.com",
      "firstname": "text",
      "lastname": "text",
      "username": "text",
      "password": "text",
      "address": "text",
      "city": "text",
      "state": "text",
      "postal": "text",
      "country": "text",
      "phone": "text",
      "fax": "text",
      "cell": "text",
      "title": "text",
      "timezone": "text",
      "datetime_format": "text",
      "language": "text",
      "is_administrator": true,
      "expires_at": "text",
      "loggedin_at": "text",
      "remember_token": "text",
      "status": "ACTIVE",
      "fullname": "text",
      "avatar": "text",
      "media": [
        {
          "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-03-22T00:20:11.338Z",
          "updated_at": "2025-03-22T00:20:11.338Z"
        }
      ],
      "birthdate": "2025-03-22",
      "delegation_user_id": "text",
      "manager_id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "force_change_password": true,
      "id": 1,
      "created_at": "2025-03-22T00:20:11.338Z",
      "updated_at": "2025-03-22T00:20:11.338Z",
      "deleted_at": "2025-03-22T00:20:11.338Z"
    }
  ]
}

success

Update a process request event

post

Trigger a intermediate catch event

Authorizations

Path parameters

process_request_idstringrequired

ID of process request to return

event_idstringrequired

ID of process event to return

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/requests/{process_request_id}/events/{event_id}'

204

No body

success

Returns the list of files associated with a request

get

Display a listing of the resource.

Authorizations

Path parameters

request_idintegerrequired

ID of the request

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 · enum · default: "asc"optional

Options: asc, desc

per_pageinteger · default: "10"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "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-03-22T00:20:11.338Z",
      "updated_at": "2025-03-22T00:20:11.338Z"
    }
  ],
  "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
  }
}

list of files

Get a file uploaded to a request

get

Display the specified resource.

Authorizations

Path parameters

request_idintegerrequired

ID of the request

file_idintegerrequired

ID of the file to return

Responses

application/octet-stream

application/json

cURL

JavaScript

Python

HTTP

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

200

404

binary

File stream

Delete all media associated with a request

delete

Remove the specified resource from storage.

Authorizations

Path parameters

file_idintegerrequired

ID of the file

request_idstringrequired

ID of the request

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

404

No body

success

Returns all process Requests that the user has access to

get

Display a listing of the resource.

Authorizations

Query parameters

typestring · enumoptional

Only return requests by type (all|in_progress|completed)

Options: all, in_progress, completed, started_me

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 · enum · default: "asc"optional

Options: asc, desc

per_pageinteger · default: "10"optional

includestring · default: ""optional

Include data from related models in payload. Comma separated list.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "data": [
    {
      "user_id": "text",
      "callable_id": "text",
      "data": {},
      "status": "ACTIVE",
      "name": "text",
      "process_id": "text",
      "process": {},
      "id": "text",
      "process_collaboration_id": "text",
      "participant_id": "text",
      "process_category_id": "text",
      "created_at": "2025-03-22T00:20:11.338Z",
      "updated_at": "2025-03-22T00:20:11.338Z",
      "user": null,
      "participants": [
        {
          "email": "name@gmail.com",
          "firstname": "text",
          "lastname": "text",
          "username": "text",
          "password": "text",
          "address": "text",
          "city": "text",
          "state": "text",
          "postal": "text",
          "country": "text",
          "phone": "text",
          "fax": "text",
          "cell": "text",
          "title": "text",
          "timezone": "text",
          "datetime_format": "text",
          "language": "text",
          "is_administrator": true,
          "expires_at": "text",
          "loggedin_at": "text",
          "remember_token": "text",
          "status": "ACTIVE",
          "fullname": "text",
          "avatar": "text",
          "media": [
            {
              "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-03-22T00:20:11.338Z",
              "updated_at": "2025-03-22T00:20:11.338Z"
            }
          ],
          "birthdate": "2025-03-22",
          "delegation_user_id": "text",
          "manager_id": "text",
          "meta": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "force_change_password": true,
          "id": 1,
          "created_at": "2025-03-22T00:20:11.338Z",
          "updated_at": "2025-03-22T00:20:11.338Z",
          "deleted_at": "2025-03-22T00:20:11.338Z"
        }
      ]
    }
  ],
  "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
  }
}

list of processes

Create or update a new setting

post

Create a new Settings css-override

Authorizations

Body

variablesstringoptional

sansSerifFontstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/customize-ui' \
  --header 'Content-Type: application/json' \
  --data '{
    "variables": "text",
    "sansSerifFont": "text"
  }'

201

{
  "key": "text",
  "config": [
    {}
  ],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": true,
  "readonly": true,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-03-22T00:20:11.338Z",
  "updated_at": "2025-03-22T00:20:11.338Z"
}

success

Update a process request

put

Update a request

Authorizations

Path parameters

process_request_idintegerrequired

ID of process request to return

Body

user_idstring · idoptional

Represents an Eloquent model of a Request which is an instance of a Process.

callable_idstring · idoptional

dataobjectoptional

statusstring · enumoptional

Options: ACTIVE, COMPLETED, ERROR, CANCELED

namestringoptional

process_idintegeroptional

processobjectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/requests/{process_request_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "user_id": "text",
    "callable_id": "text",
    "data": {},
    "status": "ACTIVE",
    "name": "text",
    "process_id": 1,
    "process": {}
  }'

204

404

No body

success

Save a new media file to a request

post

Store a newly created resource in storage.

Authorizations

Path parameters

request_idintegerrequired

ID of the request

Query parameters

data_namestringoptional

Variable name in the request data to use for the file name

Body

filestring · binaryoptional

save a new media file

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/requests/{request_id}/files' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=binary'

200

{
  "message": "text",
  "fileUploadId": 1
}

success