Requests

API Reference for ProcessMaker Request 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-16T07:54:16.679Z",
  "updated_at": "2024-11-16T07:54:16.679Z"
}

Returns all process Requests that the user has access to

Display a listing of the resource.

GET/api/1.0/requests

Query parameters

Response

200

list of processes

Body

application/json

dataarray of processRequest (all of)

metametadata (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "user_id": "text",
      "callable_id": "text",
      "status": "ACTIVE",
      "name": "text",
      "id": "text",
      "process_id": "text",
      "process_collaboration_id": "text",
      "participant_id": "text",
      "process_category_id": "text",
      "created_at": "2024-11-16T07:54:16.679Z",
      "updated_at": "2024-11-16T07:54:16.679Z",
      "participants": [
        {
          "email": "[e-mail]",
          "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": false,
          "expires_at": "text",
          "loggedin_at": "text",
          "remember_token": "text",
          "status": "ACTIVE",
          "fullname": "text",
          "avatar": "text",
          "media": [
            {
              "model_type": "text",
              "collection_name": "text",
              "name": "text",
              "file_name": "text",
              "mime_type": "text",
              "disk": "text",
              "created_at": "2024-11-16T07:54:16.679Z",
              "updated_at": "2024-11-16T07:54:16.679Z"
            }
          ],
          "birthdate": "2024-11-16",
          "delegation_user_id": "text",
          "manager_id": "text",
          "force_change_password": false,
          "created_at": "2024-11-16T07:54:16.679Z",
          "updated_at": "2024-11-16T07:54:16.679Z",
          "deleted_at": "2024-11-16T07:54:16.679Z"
        }
      ]
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}

Get single process request by ID

Display the specified resource.

GET/api/1.0/requests/{process_request_id}

Path parameters

process_request_id*integer

ID of process request to return

Query parameters

Response

200404

Successfully found the process

Body

application/json

user_idstring (id)

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

callable_idstring (id)

dataobject

statusenum

ACTIVECOMPLETEDERRORCANCELED

namestring

process_idinteger

processobject

idstring (id)

process_idstring (id)

process_collaboration_idstring (id)

participant_idstring (id)

process_category_idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

userany

participantsarray of users (all of)

Request

JavaScriptCurlPython

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

Response

200404

{
  "user_id": "text",
  "callable_id": "text",
  "status": "ACTIVE",
  "name": "text",
  "id": "text",
  "process_id": "text",
  "process_collaboration_id": "text",
  "participant_id": "text",
  "process_category_id": "text",
  "created_at": "2024-11-16T07:54:16.679Z",
  "updated_at": "2024-11-16T07:54:16.679Z",
  "participants": [
    {
      "email": "[e-mail]",
      "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": false,
      "expires_at": "text",
      "loggedin_at": "text",
      "remember_token": "text",
      "status": "ACTIVE",
      "fullname": "text",
      "avatar": "text",
      "media": [
        {
          "model_type": "text",
          "collection_name": "text",
          "name": "text",
          "file_name": "text",
          "mime_type": "text",
          "disk": "text",
          "created_at": "2024-11-16T07:54:16.679Z",
          "updated_at": "2024-11-16T07:54:16.679Z"
        }
      ],
      "birthdate": "2024-11-16",
      "delegation_user_id": "text",
      "manager_id": "text",
      "force_change_password": false,
      "created_at": "2024-11-16T07:54:16.679Z",
      "updated_at": "2024-11-16T07:54:16.679Z",
      "deleted_at": "2024-11-16T07:54:16.679Z"
    }
  ]
}

Update a process request

Update a request

PUT/api/1.0/requests/{process_request_id}

Path parameters

process_request_id*integer

ID of process request to return

Body

application/json

user_idstring (id)

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

callable_idstring (id)

dataobject

statusenum

ACTIVECOMPLETEDERRORCANCELED

namestring

process_idinteger

processobject

Response

204404

success

Request

JavaScriptCurlPython

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

Response

404

{
  "error": "text"
}

Delete a process request

Delete a request

DELETE/api/1.0/requests/{process_request_id}

Path parameters

process_request_id*integer

ID of process request to return

Response

204404

success

Body

application/json

user_idstring (id)

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

callable_idstring (id)

dataobject

statusenum

ACTIVECOMPLETEDERRORCANCELED

namestring

process_idinteger

processobject

idstring (id)

process_idstring (id)

process_collaboration_idstring (id)

participant_idstring (id)

process_category_idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

userany

participantsarray of users (all of)

Request

JavaScriptCurlPython

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

Response

204404

{
  "user_id": "text",
  "callable_id": "text",
  "status": "ACTIVE",
  "name": "text",
  "id": "text",
  "process_id": "text",
  "process_collaboration_id": "text",
  "participant_id": "text",
  "process_category_id": "text",
  "created_at": "2024-11-16T07:54:16.679Z",
  "updated_at": "2024-11-16T07:54:16.679Z",
  "participants": [
    {
      "email": "[e-mail]",
      "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": false,
      "expires_at": "text",
      "loggedin_at": "text",
      "remember_token": "text",
      "status": "ACTIVE",
      "fullname": "text",
      "avatar": "text",
      "media": [
        {
          "model_type": "text",
          "collection_name": "text",
          "name": "text",
          "file_name": "text",
          "mime_type": "text",
          "disk": "text",
          "created_at": "2024-11-16T07:54:16.679Z",
          "updated_at": "2024-11-16T07:54:16.679Z"
        }
      ],
      "birthdate": "2024-11-16",
      "delegation_user_id": "text",
      "manager_id": "text",
      "force_change_password": false,
      "created_at": "2024-11-16T07:54:16.679Z",
      "updated_at": "2024-11-16T07:54:16.679Z",
      "deleted_at": "2024-11-16T07:54:16.679Z"
    }
  ]
}

Update a process request event

Trigger a intermediate catch event

POST/api/1.0/requests/{process_request_id}/events/{event_id}

Path parameters

process_request_id*string

ID of process request to return

event_id*string

ID of process event to return

Response

204

success

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/requests/{process_request_id}/events/{event_id}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Returns the list of files associated with a request

Display a listing of the resource.

GET/api/1.0/requests/{request_id}/files

Path parameters

request_id*integer

ID of the request

Query parameters

Response

200

list of files

Body

application/json

dataarray of media (object)

metaobject

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/requests/{request_id}/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-16T07:54:16.679Z",
      "updated_at": "2024-11-16T07:54:16.679Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}

Save a new media file to a request

Store a newly created resource in storage.

POST/api/1.0/requests/{request_id}/files

Path parameters

request_id*integer

ID of the request

Query parameters

Body

multipart/form-data

filestring (binary)

save a new media file

Response

200

success

Body

application/json

messagestring

fileUploadIdinteger

Request

JavaScriptCurlPython

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

Response

200

{
  "message": "text"
}

Get a file uploaded to a request

Display the specified resource.

GET/api/1.0/requests/{request_id}/files/{file_id}

Path parameters

request_id*integer

ID of the request

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/requests/{request_id}/files/{file_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

binary

Delete all media associated with a request

Remove the specified resource from storage.

DELETE/api/1.0/requests/{request_id}/files/{file_id}

Path parameters

file_id*integer

ID of the file

request_id*string

ID of the request

Response

204404

success

Request

JavaScriptCurlPython

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

Response

404

{
  "error": "text"
}