processmaker.com Knowledge Center ProcessMaker University

Requests

API Reference for ProcessMaker Request API

PreviousGroups NextTasks

Last updated 4 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

includestringOptional

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

Default: ""

Responses

application/json

all ofOptional

application/json

get

GET /api/1.0/requests/{process_request_id} HTTP/1.1
Host: 
Accept: */*

{
  "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-04-19T09:42:31.691Z",
  "updated_at": "2025-04-19T09:42:31.691Z",
  "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-04-19T09:42:31.691Z",
          "updated_at": "2025-04-19T09:42:31.691Z"
        }
      ],
      "birthdate": "2025-04-19",
      "delegation_user_id": "text",
      "manager_id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "force_change_password": true,
      "id": 1,
      "created_at": "2025-04-19T09:42:31.691Z",
      "updated_at": "2025-04-19T09:42:31.691Z",
      "deleted_at": "2025-04-19T09:42:31.691Z"
    }
  ]
}

Delete a process request

delete

Delete a request

Authorizations

Path parameters

process_request_idintegerRequired

ID of process request to return

Responses

application/json

all ofOptional

application/json

delete

DELETE /api/1.0/requests/{process_request_id} HTTP/1.1
Host: 
Accept: */*

{
  "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-04-19T09:42:31.691Z",
  "updated_at": "2025-04-19T09:42:31.691Z",
  "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-04-19T09:42:31.691Z",
          "updated_at": "2025-04-19T09:42:31.691Z"
        }
      ],
      "birthdate": "2025-04-19",
      "delegation_user_id": "text",
      "manager_id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "force_change_password": true,
      "id": 1,
      "created_at": "2025-04-19T09:42:31.691Z",
      "updated_at": "2025-04-19T09:42:31.691Z",
      "deleted_at": "2025-04-19T09:42:31.691Z"
    }
  ]
}

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

post

POST /api/1.0/requests/{process_request_id}/events/{event_id} HTTP/1.1
Host: 
Accept: */*

204

success

No content

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 · enumOptionalDefault: ascAvailable options:

per_pageintegerOptionalDefault: 10

Responses

application/json

objectOptional

get

GET /api/1.0/requests/{request_id}/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-04-19T09:42:31.691Z",
      "updated_at": "2025-04-19T09:42:31.691Z"
    }
  ],
  "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
  }
}

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

string · binaryOptional

application/json

get

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

binary

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

delete

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

No content

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)

Available options:

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: ascAvailable options:

per_pageintegerOptionalDefault: 10

includestringOptional

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

Default: ""

Responses

application/json

objectOptional

get

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

200

list of processes

{
  "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-04-19T09:42:31.691Z",
      "updated_at": "2025-04-19T09:42:31.691Z",
      "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-04-19T09:42:31.691Z",
              "updated_at": "2025-04-19T09:42:31.691Z"
            }
          ],
          "birthdate": "2025-04-19",
          "delegation_user_id": "text",
          "manager_id": "text",
          "meta": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "force_change_password": true,
          "id": 1,
          "created_at": "2025-04-19T09:42:31.691Z",
          "updated_at": "2025-04-19T09:42:31.691Z",
          "deleted_at": "2025-04-19T09:42:31.691Z"
        }
      ]
    }
  ],
  "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

application/json

all ofOptional

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-04-19T09:42:31.691Z",
  "updated_at": "2025-04-19T09:42:31.691Z"
}

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 · enumOptionalAvailable options:

namestringOptional

process_idintegerOptional

processobjectOptional

Responses

application/json

put

PUT /api/1.0/requests/{process_request_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "user_id": "text",
  "callable_id": "text",
  "data": {},
  "status": "ACTIVE",
  "name": "text",
  "process_id": 1,
  "process": {}
}

No content

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

objectOptional

post

POST /api/1.0/requests/{request_id}/files HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

200

success

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