Saved Search | ProcessMaker Developers Documentation

processmaker.com Knowledge Center ProcessMaker University

Returns all saved search charts that the user has access to

Get a list of SavedSearchCharts.

get

/saved-searches/{saved_search_id}/charts

Authorizations

Query parameters

filterstring

Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

typestring · enum

Only return saved searches by type

Options: request, task, collection

order_bystring

Field to order results by

order_directionstring · enum · default: asc

Options: asc, desc

per_pageinteger · default: 10

includestring

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/saved-searches/{saved_search_id}/charts'

200

{
  "data": [
    {
      "id": "text",
      "saved_search_id": "text",
      "user_id": "text",
      "created_at": "2025-02-20T18:58:56.154Z",
      "updated_at": "2025-02-20T18:58:56.154Z",
      "deleted_at": "2025-02-20T18:58:56.154Z",
      "title": "text",
      "config": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "sort": 1,
      "type": "bar"
    }
  ],
  "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"
  }
}

list of saved search charts

Save a new saved search chart

Create a new SavedSearchChart.

post

/saved-searches/{saved_search_id}/charts

Authorizations

Path parameters

saved_search_idstringrequired

ID of saved search to which this chart will be saved

Body

titlestring

Represents an Eloquent model of a Saved Search Chart.

configobject

sortinteger

typestring · enum

Options: bar, bar-vertical, line, pie, doughnut

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/saved-searches/{saved_search_id}/charts' \
  --header 'Content-Type: application/json' \
  --data '{"config":{"ANY_ADDITIONAL_PROPERTY":null},"type":"bar"}'

201

{
  "id": "text",
  "saved_search_id": "text",
  "user_id": "text",
  "created_at": "2025-02-20T18:58:56.154Z",
  "updated_at": "2025-02-20T18:58:56.154Z",
  "deleted_at": "2025-02-20T18:58:56.154Z",
  "title": "text",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "sort": 1,
  "type": "bar"
}

success

Update several saved search charts at once

Batch update several SavedSearchCharts.

put

/saved-searches/{saved_search_id}/charts

Authorizations

Path parameters

saved_search_idstringrequired

ID of saved search to which these charts will be saved

Body

idstring · id

saved_search_idstring · id

user_idstring · id

created_atstring · date-time

updated_atstring · date-time

deleted_atstring · date-time

titlestring

Represents an Eloquent model of a Saved Search Chart.

configobject

sortinteger

typestring · enum

Options: bar, bar-vertical, line, pie, doughnut

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/saved-searches/{saved_search_id}/charts' \
  --header 'Content-Type: application/json' \
  --data '[{"id":"text","saved_search_id":"text","user_id":"text","created_at":"2025-02-20T18:58:56.154Z","updated_at":"2025-02-20T18:58:56.154Z","deleted_at":"2025-02-20T18:58:56.154Z","title":"text","config":{"ANY_ADDITIONAL_PROPERTY":null},"sort":1,"type":"bar"}]'

204

No body

success

Get single saved search chart by ID

Get a single SavedSearchChart.

get

/saved-searches/charts/{chart_id}

Authorizations

Path parameters

chart_idstringrequired

ID of chart to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/saved-searches/charts/{chart_id}'

200

{
  "id": "text",
  "saved_search_id": "text",
  "user_id": "text",
  "created_at": "2025-02-20T18:58:56.154Z",
  "updated_at": "2025-02-20T18:58:56.154Z",
  "deleted_at": "2025-02-20T18:58:56.154Z",
  "title": "text",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "sort": 1,
  "type": "bar"
}

Successfully found the saved search chart

Update a saved search chart

Update a SavedSearchChart.

put

/saved-searches/charts/{chart_id}

Authorizations

Path parameters

chart_idstringrequired

ID of chart to return

Body

titlestring

Represents an Eloquent model of a Saved Search Chart.

configobject

sortinteger

typestring · enum

Options: bar, bar-vertical, line, pie, doughnut

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/saved-searches/charts/{chart_id}' \
  --header 'Content-Type: application/json' \
  --data '{"config":{"ANY_ADDITIONAL_PROPERTY":null},"type":"bar"}'

200

{
  "id": "text",
  "saved_search_id": "text",
  "user_id": "text",
  "created_at": "2025-02-20T18:58:56.154Z",
  "updated_at": "2025-02-20T18:58:56.154Z",
  "deleted_at": "2025-02-20T18:58:56.154Z",
  "title": "text",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "sort": 1,
  "type": "bar"
}

success

Delete a saved search chart

Delete a SavedSearchChart.

delete

/saved-searches/charts/{chart_id}

Authorizations

Path parameters

chart_idstringrequired

ID of chart to return

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/1.0/saved-searches/charts/{chart_id}'

204

No body

success

Get available chart fields for a Saved Search by ID

Get available chart fields for a Saved Search.

get

/saved-searches/charts/{chart_id}/fields

Authorizations

Path parameters

chart_idstringrequired

ID of Saved Search to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/saved-searches/charts/{chart_id}/fields'

200

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-02-20T18:58:56.154Z",
  "updated_at": "2025-02-20T18:58:56.154Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

Successfully found the saved search

Save a new report

post

/saved-searches/reports

Authorizations

Body

saved_search_idinteger

configobject

subjectstring

bodystring

typestring · enum

Options: adhoc, scheduled

formatstring · enum

Options: csv, xlsx

tostring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/saved-searches/reports' \
  --header 'Content-Type: application/json' \
  --data '{"config":{},"type":"adhoc","format":"csv","to":[null]}'

201

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-02-20T18:58:56.154Z",
  "updated_at": "2025-02-20T18:58:56.154Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

success

Update a saved search

Update a Report

put

/saved-searches/reports/{reportId}

Authorizations

Path parameters

reportIdstringrequired

ID of report

Body

metaobject

Represents an Eloquent model of a Saved Search.

pmqlstring

titlestring

typestring · enum

Options: task, request

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/saved-searches/reports/{reportId}' \
  --header 'Content-Type: application/json' \
  --data '{"meta":{"ANY_ADDITIONAL_PROPERTY":null},"type":"task"}'

200

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-02-20T18:58:56.154Z",
  "updated_at": "2025-02-20T18:58:56.154Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

success

Returns all saved searches that the user has access to

Get a list of SavedSearches.

get

/saved-searches

Authorizations

Query parameters

filterstring

Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

typestring · enum

Only return saved searches by type

Options: request, task, collection

subsetstring · enum

Only return saved searches that are yours or those that have been shared with you

Options: mine, shared

order_bystring

Field to order results by

order_directionstring · enum · default: asc

Options: asc, desc

per_pageinteger · default: 10

includestring

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/saved-searches'

200

{
  "data": [
    {
      "id": "text",
      "user_id": "text",
      "created_at": "2025-02-20T18:58:56.154Z",
      "updated_at": "2025-02-20T18:58:56.154Z",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "pmql": "text",
      "title": "text",
      "type": "task"
    }
  ],
  "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"
  }
}

list of saved searches

Save a new saved search

Create a new SavedSearch.

post

/saved-searches

Authorizations

Body

metaobject

Represents an Eloquent model of a Saved Search.

pmqlstring

titlestring

typestring · enum

Options: task, request

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/saved-searches' \
  --header 'Content-Type: application/json' \
  --data '{"meta":{"ANY_ADDITIONAL_PROPERTY":null},"type":"task"}'

201

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-02-20T18:58:56.154Z",
  "updated_at": "2025-02-20T18:58:56.154Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

success

Get single saved searches by ID

Get a single SavedSearch.

get

/saved-searches/{savedSearchId}

Authorizations

Path parameters

savedSearchIdstringrequired

ID of saved search to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/saved-searches/{savedSearchId}'

200

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-02-20T18:58:56.154Z",
  "updated_at": "2025-02-20T18:58:56.154Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

Successfully found the saved search

Update a saved search

Update a SavedSearch.

put

/saved-searches/{savedSearchId}

Authorizations

Path parameters

savedSearchIdstringrequired

ID of saved search to return

Body

metaobject

Represents an Eloquent model of a Saved Search.

pmqlstring

titlestring

typestring · enum

Options: task, request

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/saved-searches/{savedSearchId}' \
  --header 'Content-Type: application/json' \
  --data '{"meta":{"ANY_ADDITIONAL_PROPERTY":null},"type":"task"}'

200

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-02-20T18:58:56.154Z",
  "updated_at": "2025-02-20T18:58:56.154Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

success

Returns all columns associated with a Saved Search

Display a listing of columns.

get

/saved-searches/{savedSearchId}/columns

Authorizations

Path parameters

savedSearchIdstringrequired

ID of saved search to return

Query parameters

includestring · enum[]

Include specific categories. Comma separated list.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/saved-searches/{savedSearchId}/columns'

200

{
  "current": [
    {
      "label": "text",
      "field": "text",
      "sortable": true,
      "default": true,
      "format": "text",
      "mask": "text"
    }
  ],
  "default": [
    {
      "label": "text",
      "field": "text",
      "sortable": true,
      "default": true,
      "format": "text",
      "mask": "text"
    }
  ],
  "available": [
    {
      "label": "text",
      "field": "text",
      "sortable": true,
      "default": true,
      "format": "text",
      "mask": "text"
    }
  ],
  "data": [
    {
      "label": "text",
      "field": "text",
      "sortable": true,
      "default": true,
      "format": "text",
      "mask": "text"
    }
  ]
}

Categorized list of columns

Returns all users

Display a listing of the resource.

get

/saved-searches/{savedSearchId}/users

Authorizations

Path parameters

savedSearchIdstringrequired

ID of saved search to return

Query parameters

filterstring

Filter results by string. Searches First Name, Last Name, Email and Username.

order_bystring

Field to order results by

order_directionstring · enum · default: asc

Options: asc, desc

per_pageinteger · default: 10

includestring

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/saved-searches/{savedSearchId}/users'

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": [
    {
      "email": "hello@example.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": true,
      "expires_at": "text",
      "loggedin_at": "text",
      "remember_token": "text",
      "fullname": "text",
      "avatar": "text",
      "birthdate": "2025-02-20",
      "delegation_user_id": "text",
      "manager_id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "force_change_password": true,
      "status": "ACTIVE",
      "media": [
        {
          "id": 1,
          "model_id": 1,
          "model_type": "text",
          "collection_name": "text",
          "name": "text",
          "file_name": "text",
          "mime_type": "text",
          "disk": "text",
          "size": 1,
          "manipulations": {},
          "custom_properties": {},
          "responsive_images": {},
          "order_column": 1,
          "created_at": "2025-02-20T18:58:56.154Z",
          "updated_at": "2025-02-20T18:58:56.154Z"
        }
      ],
      "id": 1,
      "created_at": "2025-02-20T18:58:56.154Z",
      "updated_at": "2025-02-20T18:58:56.154Z",
      "deleted_at": "2025-02-20T18:58:56.154Z"
    }
  ]
}

list of users

Returns all groups that the user has access to

Display a listing of the resource.

get

/saved-searches/{savedSearchId}/groups

Authorizations

Query parameters

order_bystring

Field to order results by

order_directionstring · enum · default: asc

Options: asc, desc

per_pageinteger · default: 10

includestring

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/saved-searches/{savedSearchId}/groups'

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": [
    {
      "name": "text",
      "description": "text",
      "manager_id": 1,
      "status": "ACTIVE",
      "created_at": "2025-02-20T18:58:56.154Z",
      "updated_at": "2025-02-20T18:58:56.154Z",
      "id": "text"
    }
  ]
}

list of groups

Delete a saved search

Delete a SavedSearch.

delete

/saved-searches/{saved_search_id}

Authorizations

Path parameters

saved_search_idstringrequired

ID of saved search to return

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/1.0/saved-searches/{saved_search_id}'

204

No body

success

Returns all icons for saved searches

Get a list of icons available for SavedSearches.

get

/saved-searches/icons

Authorizations

Query parameters

per_pageinteger · default: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/saved-searches/icons'

200

{
  "data": [
    {
      "name": "text",
      "value": "text"
    }
  ],
  "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"
  }
}

list of icons for saved searches