Processes

API Reference for ProcessMaker Process API

Returns all processes categories that the user has access to

Display a listing of the Process Categories.

GET/api/1.0/process_categories

Query parameters

Response

list of processes categories

Body

dataarray of ProcessCategory (all of)

metaobject

Request

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

Response

{
  "data": [
    {
      "name": "text",
      "status": "ACTIVE",
      "id": "text",
      "created_at": "2024-05-11T06:35:29.009Z",
      "updated_at": "2024-05-11T06:35:29.009Z"
    }
  ]
}

Save a new process Category

Store a newly created Process Category in storage

POST/api/1.0/process_categories

Body

namestring

Represents a business process category definition.

statusenum

ACTIVEINACTIVE

Response

success

Body

namestring

Represents a business process category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

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

Response

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2024-05-11T06:35:29.009Z",
  "updated_at": "2024-05-11T06:35:29.009Z"
}

Get single process category by ID

Display the specified Process category.

GET/api/1.0/process_categories/{process_category_id}

Path parameters

process_category_id*integer

ID of process category to return

Response

Successfully found the process

Body

namestring

Represents a business process category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

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

Response

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2024-05-11T06:35:29.009Z",
  "updated_at": "2024-05-11T06:35:29.009Z"
}

Update a process Category

Updates the current element

PUT/api/1.0/process_categories/{process_category_id}

Path parameters

process_category_id*integer

ID of process category to return

Body

namestring

Represents a business process category definition.

statusenum

ACTIVEINACTIVE

Response

success

Body

namestring

Represents a business process category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

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

Response

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2024-05-11T06:35:29.009Z",
  "updated_at": "2024-05-11T06:35:29.009Z"
}

Delete a process category

Remove the specified resource from storage.

DELETE/api/1.0/process_categories/{process_category_id}

Path parameters

process_category_id*integer

ID of process category to return

Response

success

Body

process_category_idinteger (id)

Represents a business process definition.

namestring

descriptionstring

statusenum

ACTIVEINACTIVEARCHIVED

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger (id)

is_validinteger

package_keystring

start_eventsarray of ProcessStartEvents (object)

warningsstring

self_service_tasksobject

signal_eventsarray of object

categoryobject

manager_idinteger (id)

user_idinteger (id)

idstring (id)

deleted_atstring (date-time)

created_atstring (date-time)

updated_atstring (date-time)

notificationsobject

task_notificationsobject

Request

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

Response

{
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "has_timer_start_events": false,
  "package_key": "text",
  "start_events": [
    {
      "parallelMultiple": false,
      "id": "text",
      "name": "text"
    }
  ],
  "warnings": "text",
  "signal_events": [],
  "id": "text",
  "deleted_at": "2024-05-11T06:35:29.009Z",
  "created_at": "2024-05-11T06:35:29.009Z",
  "updated_at": "2024-05-11T06:35:29.009Z"
}

Returns all processes that the user has access to

Get list Process

GET/api/1.0/processes

Query parameters

Response

list of processes

Body

dataarray of Process (all of)

metametadata (object)

Request

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

Response

{
  "data": [
    {
      "name": "text",
      "description": "text",
      "status": "ACTIVE",
      "has_timer_start_events": false,
      "package_key": "text",
      "start_events": [
        {
          "parallelMultiple": false,
          "id": "text",
          "name": "text"
        }
      ],
      "warnings": "text",
      "signal_events": [],
      "id": "text",
      "deleted_at": "2024-05-11T06:35:29.009Z",
      "created_at": "2024-05-11T06:35:29.009Z",
      "updated_at": "2024-05-11T06:35:29.009Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}

Save a new process

Store a newly created resource in storage.

POST/api/1.0/processes

Body

process_category_idinteger (id)

Represents a business process definition.

namestring

descriptionstring

statusenum

ACTIVEINACTIVEARCHIVED

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger (id)

is_validinteger

package_keystring

start_eventsarray of ProcessStartEvents (object)

warningsstring

self_service_tasksobject

signal_eventsarray of object

categoryobject

manager_idinteger (id)

Response

success

Body

process_category_idinteger (id)

Represents a business process definition.

namestring

descriptionstring

statusenum

ACTIVEINACTIVEARCHIVED

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger (id)

is_validinteger

package_keystring

start_eventsarray of ProcessStartEvents (object)

warningsstring

self_service_tasksobject

signal_eventsarray of object

categoryobject

manager_idinteger (id)

user_idinteger (id)

idstring (id)

deleted_atstring (date-time)

created_atstring (date-time)

updated_atstring (date-time)

notificationsobject

task_notificationsobject

Request

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

Response

{
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "has_timer_start_events": false,
  "package_key": "text",
  "start_events": [
    {
      "parallelMultiple": false,
      "id": "text",
      "name": "text"
    }
  ],
  "warnings": "text",
  "signal_events": [],
  "id": "text",
  "deleted_at": "2024-05-11T06:35:29.009Z",
  "created_at": "2024-05-11T06:35:29.009Z",
  "updated_at": "2024-05-11T06:35:29.009Z"
}

Get single process by ID

Display the specified resource.

GET/api/1.0/processes/{processId}

Path parameters

processId*integer

ID of process to return

Query parameters

Response

Successfully found the process

Body

process_category_idinteger (id)

Represents a business process definition.

namestring

descriptionstring

statusenum

ACTIVEINACTIVEARCHIVED

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger (id)

is_validinteger

package_keystring

start_eventsarray of ProcessStartEvents (object)

warningsstring

self_service_tasksobject

signal_eventsarray of object

categoryobject

manager_idinteger (id)

user_idinteger (id)

idstring (id)

deleted_atstring (date-time)

created_atstring (date-time)

updated_atstring (date-time)

notificationsobject

task_notificationsobject

Request

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

Response

{
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "has_timer_start_events": false,
  "package_key": "text",
  "start_events": [
    {
      "parallelMultiple": false,
      "id": "text",
      "name": "text"
    }
  ],
  "warnings": "text",
  "signal_events": [],
  "id": "text",
  "deleted_at": "2024-05-11T06:35:29.009Z",
  "created_at": "2024-05-11T06:35:29.009Z",
  "updated_at": "2024-05-11T06:35:29.009Z"
}

Update a process

Updates the current element.

PUT/api/1.0/processes/{processId}

Path parameters

processId*integer

ID of process to return

Body

process_category_idinteger (id)

Represents a business process definition.

namestring

descriptionstring

statusenum

ACTIVEINACTIVEARCHIVED

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger (id)

is_validinteger

package_keystring

start_eventsarray of ProcessStartEvents (object)

warningsstring

self_service_tasksobject

signal_eventsarray of object

categoryobject

manager_idinteger (id)

Response

success

Body

process_category_idinteger (id)

Represents a business process definition.

namestring

descriptionstring

statusenum

ACTIVEINACTIVEARCHIVED

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger (id)

is_validinteger

package_keystring

start_eventsarray of ProcessStartEvents (object)

warningsstring

self_service_tasksobject

signal_eventsarray of object

categoryobject

manager_idinteger (id)

user_idinteger (id)

idstring (id)

deleted_atstring (date-time)

created_atstring (date-time)

updated_atstring (date-time)

notificationsobject

task_notificationsobject

Request

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

Response

{
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "has_timer_start_events": false,
  "package_key": "text",
  "start_events": [
    {
      "parallelMultiple": false,
      "id": "text",
      "name": "text"
    }
  ],
  "warnings": "text",
  "signal_events": [],
  "id": "text",
  "deleted_at": "2024-05-11T06:35:29.009Z",
  "created_at": "2024-05-11T06:35:29.009Z",
  "updated_at": "2024-05-11T06:35:29.009Z"
}

Delete a process

Remove the specified resource from storage.

DELETE/api/1.0/processes/{processId}

Path parameters

processId*integer

ID of process to return

Response

success

Request

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

Returns the list of processes that the user can start

Returns the list of processes that the user can start.

GET/api/1.0/start_processes

Path parameters

without_event_definitionsboolean

If true return only processes that haven't start event definitions

Query parameters

Response

list of processes that the user can start

Body

dataarray of ProcessWithStartEvents (all of)

metametadata (object)

Request

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

Response

{
  "data": [
    {
      "name": "text",
      "description": "text",
      "status": "ACTIVE",
      "has_timer_start_events": false,
      "package_key": "text",
      "start_events": [
        {
          "parallelMultiple": false,
          "id": "text",
          "name": "text"
        }
      ],
      "warnings": "text",
      "signal_events": [],
      "id": "text",
      "deleted_at": "2024-05-11T06:35:29.009Z",
      "created_at": "2024-05-11T06:35:29.009Z",
      "updated_at": "2024-05-11T06:35:29.009Z",
      "events": [
        {
          "parallelMultiple": false,
          "id": "text",
          "name": "text"
        }
      ]
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}

Restore an inactive process

Reverses the soft delete of the element.

PUT/api/1.0/processes/{processId}/restore

Path parameters

processId*integer

ID of process to return

Response

success

Body

process_category_idinteger (id)

Represents a business process definition.

namestring

descriptionstring

statusenum

ACTIVEINACTIVEARCHIVED

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger (id)

is_validinteger

package_keystring

start_eventsarray of ProcessStartEvents (object)

warningsstring

self_service_tasksobject

signal_eventsarray of object

categoryobject

manager_idinteger (id)

user_idinteger (id)

idstring (id)

deleted_atstring (date-time)

created_atstring (date-time)

updated_atstring (date-time)

notificationsobject

task_notificationsobject

Request

const response = await fetch('/api/1.0/processes/{processId}/restore', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "has_timer_start_events": false,
  "package_key": "text",
  "start_events": [
    {
      "parallelMultiple": false,
      "id": "text",
      "name": "text"
    }
  ],
  "warnings": "text",
  "signal_events": [],
  "id": "text",
  "deleted_at": "2024-05-11T06:35:29.009Z",
  "created_at": "2024-05-11T06:35:29.009Z",
  "updated_at": "2024-05-11T06:35:29.009Z"
}

Export a single process by ID and return a URL to download it

Export the specified process.

POST/api/1.0/processes/{processId}/export

Path parameters

processId*integer

ID of process to export

Response

Successfully built the process for export

Body

urlstring

Request

const response = await fetch('/api/1.0/processes/{processId}/export', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "url": "text"
}

Validate a import

Validate the specified process before importing.

POST/api/1.0/processes/import/validation

Body

filestring (binary)

file to import

Response

success

Body

process_category_idinteger (id)

Represents a business process definition.

namestring

descriptionstring

statusenum

ACTIVEINACTIVEARCHIVED

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger (id)

is_validinteger

package_keystring

start_eventsarray of ProcessStartEvents (object)

warningsstring

self_service_tasksobject

signal_eventsarray of object

categoryobject

manager_idinteger (id)

statusarray of object

assignablearray of object

processany

Request

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

Response

{
  "name": "text",
  "description": "text",
  "status": [],
  "has_timer_start_events": false,
  "package_key": "text",
  "start_events": [
    {
      "parallelMultiple": false,
      "id": "text",
      "name": "text"
    }
  ],
  "warnings": "text",
  "signal_events": [],
  "assignable": []
}

Import a new process

Import the specified process.

POST/api/1.0/processes/import

Body

filestring (binary)

file to import

Response

success

Body

process_category_idinteger (id)

Represents a business process definition.

namestring

descriptionstring

statusenum

ACTIVEINACTIVEARCHIVED

pause_timer_startinteger

cancel_screen_idinteger

has_timer_start_eventsboolean

request_detail_screen_idinteger (id)

is_validinteger

package_keystring

start_eventsarray of ProcessStartEvents (object)

warningsstring

self_service_tasksobject

signal_eventsarray of object

categoryobject

manager_idinteger (id)

statusarray of object

assignablearray of object

processany

Request

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

Response

{
  "name": "text",
  "description": "text",
  "status": [],
  "has_timer_start_events": false,
  "package_key": "text",
  "start_events": [
    {
      "parallelMultiple": false,
      "id": "text",
      "name": "text"
    }
  ],
  "warnings": "text",
  "signal_events": [],
  "assignable": []
}

Check if the import is ready

HEAD/api/1.0/processes/import/{code}/is_ready

Path parameters

code*string

Import code

Response

check is import is ready

Body

readyboolean

Request

const response = await fetch('/api/1.0/processes/import/{code}/is_ready', {
    method: 'HEAD',
    headers: {},
});
const data = await response.json();

Response

{
  "ready": false
}

Update assignments after import

Import Assignments of process.

POST/api/1.0/processes/{process_id}/import/assignments

Path parameters

process_id*integer

ID of process to return

Body

assignablearray of object

cancel_requestobject

edit_dataobject

Response

success

Request

const response = await fetch('/api/1.0/processes/{process_id}/import/assignments', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Start a new process

Trigger an start event within a process.

POST/api/1.0/process_events/{process_id}

Path parameters

process_id*integer

ID of process to return

Query parameters

Body

data that will be stored as part of the created request

object

Response

success

Body

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

const response = await fetch('/api/1.0/process_events/{process_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

{
  "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-05-11T06:35:29.009Z",
  "updated_at": "2024-05-11T06:35:29.009Z",
  "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": 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-05-11T06:35:29.009Z",
          "updated_at": "2024-05-11T06:35:29.009Z"
        }
      ],
      "birthdate": "2024-05-11",
      "delegation_user_id": "text",
      "manager_id": "text",
      "force_change_password": false,
      "created_at": "2024-05-11T06:35:29.009Z",
      "updated_at": "2024-05-11T06:35:29.009Z",
      "deleted_at": "2024-05-11T06:35:29.009Z"
    }
  ]
}

Last updated 11 months ago