API
processmaker.comAPI ReferenceKnowledge CenterProcessMaker University

Tasks

API Reference for ProcessMaker Task API

Create or update a new setting

Create a new Settings css-override

POST/api/1.0/customize-ui
Body
variablesstring
sansSerifFontstring
Response

success

Body
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
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
{
  "key": "text",
  "config": [],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": false,
  "readonly": false,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2024-10-16T08:47:14.544Z",
  "updated_at": "2024-10-16T08:47:14.544Z"
}

Returns all task assignments

Display a listing of the resource.

GET/api/1.0/task_assignments
Query parameters
Response

list of task assignments

Body
dataarray of taskAssignments (object)
metaobject
Request
const response = await fetch('/api/1.0/task_assignments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "data": [
    {
      "process_task_id": "text",
      "assignment_type": "ProcessMaker\\Models\\User",
      "created_at": "2024-10-16T08:47:14.544Z",
      "updated_at": "2024-10-16T08:47:14.544Z"
    }
  ]
}

Save a new Task Assignment

Store a newly created task assignment in storage.

POST/api/1.0/task_assignments
Body
process_idinteger (id)

Represents a business process task assignment definition.

process_task_idstring (id)
assignment_idinteger (id)
assignment_typeenum
ProcessMaker\Models\UserProcessMaker\Models\Group
Response

success

Body
process_idinteger (id)

Represents a business process task assignment definition.

process_task_idstring (id)
assignment_idinteger (id)
assignment_typeenum
ProcessMaker\Models\UserProcessMaker\Models\Group
idinteger (id)
created_atstring (date-time)
updated_atstring (date-time)
Request
const response = await fetch('/api/1.0/task_assignments', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "process_task_id": "text",
  "assignment_type": "ProcessMaker\\Models\\User",
  "created_at": "2024-10-16T08:47:14.544Z",
  "updated_at": "2024-10-16T08:47:14.544Z"
}

Update a Task Assignment

Update a task assignment

PUT/api/1.0/task_assignments/{task_assignment}
Path parameters
task_assignment*integer

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_typeenum
ProcessMaker\Models\UserProcessMaker\Models\Group
Response

success

Request
const response = await fetch('/api/1.0/task_assignments/{task_assignment}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "error": "text"
}

Delete a Task Assignment

Remove an assignment

DELETE/api/1.0/task_assignments/{task_assignment}
Path parameters
task_assignment*integer

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_typeenum
ProcessMaker\Models\UserProcessMaker\Models\Group
Response

success

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

Returns all tasks that the user has access to

Display a listing of the resource.

GET/api/1.0/tasks
Query parameters
Response

list of tasks

Body
dataarray of processRequestToken (all of)
metametadata (object)
Request
const response = await fetch('/api/1.0/tasks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "data": [
    {
      "user_id": "text",
      "status": "text",
      "due_at": "2024-10-16T08:47:14.544Z",
      "initiated_at": "2024-10-16T08:47:14.544Z",
      "riskchanges_at": "2024-10-16T08:47:14.544Z",
      "subprocess_start_event_id": "text",
      "id": "text",
      "process_id": "text",
      "process_request_id": "text",
      "element_id": "text",
      "element_type": "text",
      "element_index": "text",
      "element_name": "text",
      "created_at": "2024-10-16T08:47:14.544Z",
      "updated_at": "2024-10-16T08:47:14.544Z",
      "advanceStatus": "text"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "path": "text"
  }
}

Get a single task by ID

Display the specified resource.

GET/api/1.0/tasks/{task_id}
Path parameters
task_id*integer

task id

Query parameters
Response

success

Body
user_idstring (id)

ProcessRequestToken is used to store the state of a token of the Nayra engine

statusstring
due_atstring (date-time)
initiated_atstring (date-time)
riskchanges_atstring (date-time)
subprocess_start_event_idstring
dataobject
idstring (id)
process_idstring (id)
process_request_idstring (id)
element_idstring (id)
element_typestring (id)
element_indexstring
element_namestring
created_atstring (date-time)
updated_atstring (date-time)
initiated_atstring (date-time)
advanceStatusstring
due_notifiedinteger
userobject
processobject
process_requestobject
Request
const response = await fetch('/api/1.0/tasks/{task_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "user_id": "text",
  "status": "text",
  "due_at": "2024-10-16T08:47:14.544Z",
  "initiated_at": "2024-10-16T08:47:14.544Z",
  "riskchanges_at": "2024-10-16T08:47:14.544Z",
  "subprocess_start_event_id": "text",
  "id": "text",
  "process_id": "text",
  "process_request_id": "text",
  "element_id": "text",
  "element_type": "text",
  "element_index": "text",
  "element_name": "text",
  "created_at": "2024-10-16T08:47:14.544Z",
  "updated_at": "2024-10-16T08:47:14.544Z",
  "advanceStatus": "text"
}

Update a task

Updates the current element

PUT/api/1.0/tasks/{task_id}
Path parameters
task_id*integer

ID of task to update

Body
status*string
Example: "COMPLETED"
data*object
Response

success

Body
user_idstring (id)

ProcessRequestToken is used to store the state of a token of the Nayra engine

statusstring
due_atstring (date-time)
initiated_atstring (date-time)
riskchanges_atstring (date-time)
subprocess_start_event_idstring
dataobject
idstring (id)
process_idstring (id)
process_request_idstring (id)
element_idstring (id)
element_typestring (id)
element_indexstring
element_namestring
created_atstring (date-time)
updated_atstring (date-time)
initiated_atstring (date-time)
advanceStatusstring
due_notifiedinteger
userobject
processobject
process_requestobject
Request
const response = await fetch('/api/1.0/tasks/{task_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "status": "COMPLETED"
    }),
});
const data = await response.json();
Response
{
  "user_id": "text",
  "status": "text",
  "due_at": "2024-10-16T08:47:14.544Z",
  "initiated_at": "2024-10-16T08:47:14.544Z",
  "riskchanges_at": "2024-10-16T08:47:14.544Z",
  "subprocess_start_event_id": "text",
  "id": "text",
  "process_id": "text",
  "process_request_id": "text",
  "element_id": "text",
  "element_type": "text",
  "element_index": "text",
  "element_name": "text",
  "created_at": "2024-10-16T08:47:14.544Z",
  "updated_at": "2024-10-16T08:47:14.544Z",
  "advanceStatus": "text"
}
PreviousRequestsNextProcesses

Last updated

Logo

© 2024 ProcessMaker, Inc. All Rights Reserved. Except as otherwise permitted by ProcessMaker, this publication, or parts thereof, may not be reproduced in any form, by any method, for any purpose.