processmaker.com Knowledge Center ProcessMaker University

Collections

PreviousData Connectors NextDecision Engine

Last updated 2 months ago

Was this helpful?

Returns all collections that the user has access to

Get a list of Collections.

get

/collections

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

includestring

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

Responses

application/json

cURL

JavaScript

Python

HTTP

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

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",
      "custom_title": "text",
      "create_screen_id": "text",
      "read_screen_id": "text",
      "update_screen_id": "text",
      "signal_create": true,
      "signal_update": true,
      "signal_delete": true,
      "id": 1,
      "created_at": "2025-02-20T19:05:43.254Z",
      "updated_at": "2025-02-20T19:05:43.254Z",
      "created_by_id": "text",
      "updated_by_id": "text",
      "columns": [
        {}
      ]
    }
  ]
}

list of collections

Save a new collections

Create a new Collection.

post

/collections

Authorizations

Body

namestring

descriptionstring

custom_titlestring

create_screen_idstring · id

read_screen_idstring · id

update_screen_idstring · id

signal_createboolean

signal_updateboolean

signal_deleteboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

{
  "name": "text",
  "description": "text",
  "custom_title": "text",
  "create_screen_id": "text",
  "read_screen_id": "text",
  "update_screen_id": "text",
  "signal_create": true,
  "signal_update": true,
  "signal_delete": true,
  "id": 1,
  "created_at": "2025-02-20T19:05:43.254Z",
  "updated_at": "2025-02-20T19:05:43.254Z",
  "created_by_id": "text",
  "updated_by_id": "text",
  "columns": [
    {}
  ]
}

success

Get single collections by ID

Get a single Collection.

get

/collections/{collection_id}

Authorizations

Path parameters

collection_idstringrequired

ID of collection to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/collections/{collection_id}'

200

{
  "name": "text",
  "description": "text",
  "custom_title": "text",
  "create_screen_id": "text",
  "read_screen_id": "text",
  "update_screen_id": "text",
  "signal_create": true,
  "signal_update": true,
  "signal_delete": true,
  "id": 1,
  "created_at": "2025-02-20T19:05:43.254Z",
  "updated_at": "2025-02-20T19:05:43.254Z",
  "created_by_id": "text",
  "updated_by_id": "text",
  "columns": [
    {}
  ]
}

Successfully found the collections

Update a collection

Update a Collection.

put

/collections/{collection_id}

Authorizations

Path parameters

collection_idstringrequired

ID of collection to update

Body

namestring

descriptionstring

custom_titlestring

create_screen_idstring · id

read_screen_idstring · id

update_screen_idstring · id

signal_createboolean

signal_updateboolean

signal_deleteboolean

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/collections/{collection_id}' \
  --header 'Content-Type: application/json'

204

No body

success

Delete a collection

Delete a Collection.

delete

/collections/{collection_id}

Authorizations

Path parameters

collection_idstringrequired

ID of collection to return

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/1.0/collections/{collection_id}'

204

No body

success

Trigger export collections job

Export the specified collection.

post

/collections/{collection_id}/export

Authorizations

Path parameters

collection_idstringrequired

ID of the collection to export

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/collections/{collection_id}/export'

202

No body

success

Import a new collection

Import the specified collection.

post

/collections/import

Authorizations

Body

filefile · filerequired

file to upload

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/collections/import' \
  --header 'Content-Type: multipart/form-data' \
  --data '{"file":null}'

200

201

No body

success

Deletes all records in a collection

Truncate a Collection.

delete

/collections/{collection_id}/truncate

Authorizations

Path parameters

collection_idstringrequired

ID of collection to truncate

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/1.0/collections/{collection_id}/truncate'

204

No body

success

Returns all records

Get the list of records of a collection.

get

/collections/{collection_id}/records

Authorizations

Path parameters

collection_idstringrequired

ID of collection to get records for

Query parameters

pmqlstring

per_pageinteger · default: 10

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/collections/{collection_id}/records'

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": [
    {
      "data": {},
      "id": 1,
      "collection_id": "text"
    }
  ]
}

list of records of a collection

Save a new record in a collection

Create a new record in a Collection.

post

/collections/{collection_id}/records

Authorizations

Path parameters

collection_idstringrequired

ID of the collection

Body

dataobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/collections/{collection_id}/records' \
  --header 'Content-Type: application/json' \
  --data '{"data":{}}'

201

{
  "data": {},
  "id": 1,
  "collection_id": "text"
}

success

Get single record of a collection

Get a single record of a Collection.

get

/collections/{collection_id}/records/{record_id}

Authorizations

Path parameters

collection_idstringrequired

ID of the collection

record_idstringrequired

ID of the record to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/collections/{collection_id}/records/{record_id}'

200

{
  "data": {},
  "id": 1,
  "collection_id": "text"
}

Successfully found the record

Update a record

Update a record in a Collection.

put

/collections/{collection_id}/records/{record_id}

Authorizations

Path parameters

collection_idstringrequired

ID of collection

record_idstringrequired

ID of the record

Body

dataobject

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/collections/{collection_id}/records/{record_id}' \
  --header 'Content-Type: application/json' \
  --data '{"data":{}}'

204

No body

success

Delete a collection record

Delete a record of a Collection.

delete

/collections/{collection_id}/records/{record_id}

Authorizations

Path parameters

collection_idstringrequired

ID of collection

record_idstringrequired

ID of record in collection

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/1.0/collections/{collection_id}/records/{record_id}'

204

No body

success

Partial update of a record

Implements a partial update of a record in a Collection.

patch

/collections/{collection_id}/records/{record_id}

Authorizations

Path parameters

collection_idstringrequired

ID of collection

record_idstringrequired

ID of the record

Body

namestring

descriptionstring

custom_titlestring

create_screen_idstring · id

read_screen_idstring · id

update_screen_idstring · id

signal_createboolean

signal_updateboolean

signal_deleteboolean

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/api/1.0/collections/{collection_id}/records/{record_id}' \
  --header 'Content-Type: application/json'

200

No body

success