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

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

JavaScriptCurlPythonHTTP

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": "2025-01-24T16:26:13.242Z",
  "updated_at": "2025-01-24T16:26:13.242Z"
}

Returns all task assignments

Display a listing of the resource.

GET/api/1.0/task_assignments

Query parameters

Response

200

list of task assignments

Body

application/json

dataarray of taskAssignments (object)

metaobject

Request

JavaScriptCurlPythonHTTP

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

Response

200

{
  "data": [
    {
      "process_id": 0,
      "process_task_id": "text",
      "assignment_id": 0,
      "assignment_type": "ProcessMaker\\Models\\User",
      "id": 0,
      "created_at": "2025-01-24T16:26:13.242Z",
      "updated_at": "2025-01-24T16:26:13.242Z"
    }
  ]
}

Save a new Task Assignment

Store a newly created task assignment in storage.

POST/api/1.0/task_assignments

Body

application/json

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

201422

success

Body

application/json

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

JavaScriptCurlPythonHTTP

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

201422

{
  "process_id": 0,
  "process_task_id": "text",
  "assignment_id": 0,
  "assignment_type": "ProcessMaker\\Models\\User",
  "id": 0,
  "created_at": "2025-01-24T16:26:13.242Z",
  "updated_at": "2025-01-24T16:26:13.242Z"
}

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

application/json

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

204404422

success

Request

JavaScriptCurlPythonHTTP

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

404422

{
  "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

application/json

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

200

success

Request

JavaScriptCurlPythonHTTP

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();

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

200404

success

Body

application/json

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

JavaScriptCurlPythonHTTP

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

Response

200404

{
  "user_id": "text",
  "status": "text",
  "due_at": "2025-01-24T16:26:13.242Z",
  "initiated_at": "2025-01-24T16:26:13.242Z",
  "riskchanges_at": "2025-01-24T16:26:13.242Z",
  "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": "2025-01-24T16:26:13.242Z",
  "updated_at": "2025-01-24T16:26:13.242Z",
  "advanceStatus": "text",
  "due_notified": 0
}

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

application/json

status*string

Example: "COMPLETED"

data*object

Response

200404422

success

Body

application/json

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

JavaScriptCurlPythonHTTP

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

200404422

{
  "user_id": "text",
  "status": "text",
  "due_at": "2025-01-24T16:26:13.242Z",
  "initiated_at": "2025-01-24T16:26:13.242Z",
  "riskchanges_at": "2025-01-24T16:26:13.242Z",
  "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": "2025-01-24T16:26:13.242Z",
  "updated_at": "2025-01-24T16:26:13.242Z",
  "advanceStatus": "text",
  "due_notified": 0
}