processmaker.com Knowledge Center ProcessMaker University

Tasks

API Reference for ProcessMaker Task API

PreviousRequests NextProcesses

Last updated 2 months ago

Was this helpful?

Create or update a new setting

Create a new Settings css-override

post

/customize-ui

Authorizations

Body

variablesstring

sansSerifFontstring

Responses

application/json

cURL

JavaScript

Python

HTTP

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

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-20T18:54:13.995Z",
  "updated_at": "2025-02-20T18:54:13.995Z"
}

success

Returns all task assignments

Display a listing of the resource.

get

/task_assignments

Authorizations

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 -L \
  --url '/api/1.0/task_assignments'

200

{
  "meta": {},
  "data": [
    {
      "process_id": 1,
      "process_task_id": "text",
      "assignment_id": 1,
      "assignment_type": "ProcessMaker\\Models\\User",
      "id": 1,
      "created_at": "2025-02-20T18:54:13.995Z",
      "updated_at": "2025-02-20T18:54:13.995Z"
    }
  ]
}

list of task assignments

Save a new Task Assignment

Store a newly created task assignment in storage.

post

/task_assignments

Authorizations

Body

process_idinteger · id

Represents a business process task assignment definition.

process_task_idstring · id

assignment_idinteger · id

assignment_typestring · enum

Options: ProcessMaker\Models\User, ProcessMaker\Models\Group

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/task_assignments' \
  --header 'Content-Type: application/json' \
  --data '{"assignment_type":"ProcessMaker\\Models\\User"}'

201

422

{
  "process_id": 1,
  "process_task_id": "text",
  "assignment_id": 1,
  "assignment_type": "ProcessMaker\\Models\\User",
  "id": 1,
  "created_at": "2025-02-20T18:54:13.995Z",
  "updated_at": "2025-02-20T18:54:13.995Z"
}

success

Update a Task Assignment

Update a task assignment

put

/task_assignments/{task_assignment}

Authorizations

Path parameters

task_assignmentintegerrequired

ID of task assignment to update

Body

process_idinteger · id

Represents a business process task assignment definition.

process_task_idstring · id

assignment_idinteger · id

assignment_typestring · enum

Options: ProcessMaker\Models\User, ProcessMaker\Models\Group

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/task_assignments/{task_assignment}' \
  --header 'Content-Type: application/json' \
  --data '{"assignment_type":"ProcessMaker\\Models\\User"}'

204

404

422

No body

success

Delete a Task Assignment

Remove an assignment

delete

/task_assignments/{task_assignment}

Authorizations

Path parameters

task_assignmentintegerrequired

ID of task assignment to delete

Body

process_idinteger · id

Represents a business process task assignment definition.

process_task_idstring · id

assignment_idinteger · id

assignment_typestring · enum

Options: ProcessMaker\Models\User, ProcessMaker\Models\Group

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/1.0/task_assignments/{task_assignment}' \
  --header 'Content-Type: application/json' \
  --data '{"assignment_type":"ProcessMaker\\Models\\User"}'

200

No body

success

Returns all tasks that the user has access to

Display a listing of the resource.

get

/tasks

Authorizations

Query parameters

process_request_idinteger

Process request id

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

includestring

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

Responses

application/json

cURL

JavaScript

Python

HTTP

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

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": [
    {
      "user_id": "text",
      "status": "text",
      "due_at": "2025-02-20T18:54:13.995Z",
      "initiated_at": "2025-02-20T18:54:13.995Z",
      "riskchanges_at": "2025-02-20T18:54:13.995Z",
      "subprocess_start_event_id": "text",
      "data": {},
      "id": "text",
      "process_id": "text",
      "process_request_id": "text",
      "element_id": "text",
      "element_type": "text",
      "element_index": "text",
      "element_name": "text",
      "created_at": "2025-02-20T18:54:13.995Z",
      "updated_at": "2025-02-20T18:54:13.995Z",
      "advanceStatus": "text",
      "due_notified": 1,
      "user": {},
      "process": {},
      "process_request": {}
    }
  ]
}

list of tasks

Get a single task by ID

Display the specified resource.

get

/tasks/{task_id}

Authorizations

Path parameters

task_idintegerrequired

task id

Query parameters

includestring

include

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/tasks/{task_id}'

200

404

{
  "user_id": "text",
  "status": "text",
  "due_at": "2025-02-20T18:54:13.995Z",
  "initiated_at": "2025-02-20T18:54:13.995Z",
  "riskchanges_at": "2025-02-20T18:54:13.995Z",
  "subprocess_start_event_id": "text",
  "data": {},
  "id": "text",
  "process_id": "text",
  "process_request_id": "text",
  "element_id": "text",
  "element_type": "text",
  "element_index": "text",
  "element_name": "text",
  "created_at": "2025-02-20T18:54:13.995Z",
  "updated_at": "2025-02-20T18:54:13.995Z",
  "advanceStatus": "text",
  "due_notified": 1,
  "user": {},
  "process": {},
  "process_request": {}
}

success

Update a task

Updates the current element

put

/tasks/{task_id}

Authorizations

Path parameters

task_idintegerrequired

ID of task to update

Body

statusstringrequired

Example: COMPLETED

dataobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/tasks/{task_id}' \
  --header 'Content-Type: application/json' \
  --data '{"status":"COMPLETED","data":{}}'

200

404

422

{
  "user_id": "text",
  "status": "text",
  "due_at": "2025-02-20T18:54:13.995Z",
  "initiated_at": "2025-02-20T18:54:13.995Z",
  "riskchanges_at": "2025-02-20T18:54:13.995Z",
  "subprocess_start_event_id": "text",
  "data": {},
  "id": "text",
  "process_id": "text",
  "process_request_id": "text",
  "element_id": "text",
  "element_type": "text",
  "element_index": "text",
  "element_name": "text",
  "created_at": "2025-02-20T18:54:13.995Z",
  "updated_at": "2025-02-20T18:54:13.995Z",
  "advanceStatus": "text",
  "due_notified": 1,
  "user": {},
  "process": {},
  "process_request": {}
}

success