processmaker.com Knowledge Center ProcessMaker University

Screens

API Reference for ProcessMaker Screen API

PreviousProcesses NextEnvironment Variables

Last updated 3 months ago

Was this helpful?

Get single screen category by ID

get

Display the specified screen category.

Authorizations

Path parameters

screen_category_idstringrequired

ID of screen category to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/screen_categories/{screen_category_id}'

200

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-03-22T01:33:17.642Z",
  "updated_at": "2025-03-22T01:33:17.642Z"
}

Successfully found the screen

Delete a screen category

delete

Remove the specified resource from storage.

Authorizations

Path parameters

screen_category_idstringrequired

ID of screen category to return

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/1.0/screen_categories/{screen_category_id}'

204

No body

success

Returns all screens that the user has access to

get

Get a list of Screens.

Authorizations

Query parameters

filterstringoptional

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

order_bystringoptional

Field to order results by

order_directionstring · enum · default: "asc"optional

Options: asc, desc

per_pageinteger · default: "10"optional

includestring · default: ""optional

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

excludestring · default: ""optional

Comma separated list of fields to exclude from the response

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "data": [
    {
      "title": "text",
      "type": "text",
      "description": "text",
      "config": [
        {}
      ],
      "computed": [
        {}
      ],
      "watchers": [
        {}
      ],
      "custom_css": "text",
      "screen_category_id": "text",
      "id": "text",
      "created_at": "2025-03-22T01:33:17.642Z",
      "updated_at": "2025-03-22T01:33:17.642Z"
    }
  ],
  "meta": {}
}

list of screens

Get single screens by ID

get

Get a single Screen.

Authorizations

Path parameters

screens_idstringrequired

ID of screens to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/screens/{screens_id}'

200

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [
    {}
  ],
  "computed": [
    {}
  ],
  "watchers": [
    {}
  ],
  "custom_css": "text",
  "screen_category_id": "text",
  "id": "text",
  "created_at": "2025-03-22T01:33:17.642Z",
  "updated_at": "2025-03-22T01:33:17.642Z"
}

Successfully found the screen

Delete a screen

delete

Delete a Screen.

Authorizations

Path parameters

screens_idstringrequired

ID of screen to return

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/1.0/screens/{screens_id}'

204

No body

success

Export a single screen by ID

post

Export the specified screen.

Authorizations

Path parameters

screensIdstringrequired

ID of screen to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/screens/{screensId}/export'

200

{
  "url": "text"
}

Successfully exported the screen

Returns all screens categories that the user has access to

get

Display a listing of the Screen Categories.

Authorizations

Query parameters

filterstringoptional

Filter results by string. Searches Name, Description, and Status. All fields must match exactly.

order_bystringoptional

Field to order results by

order_directionstring · enum · default: "asc"optional

Options: asc, desc

per_pageinteger · default: "10"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "data": [
    {
      "name": "text",
      "status": "ACTIVE",
      "id": "text",
      "created_at": "2025-03-22T01:33:17.642Z",
      "updated_at": "2025-03-22T01:33:17.642Z"
    }
  ],
  "meta": {}
}

list of screens categories

Create or update a new setting

post

Create a new Settings css-override

Authorizations

Body

variablesstringoptional

sansSerifFontstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/customize-ui' \
  --header 'Content-Type: application/json' \
  --data '{
    "variables": "text",
    "sansSerifFont": "text"
  }'

201

{
  "key": "text",
  "config": [
    {}
  ],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": true,
  "readonly": true,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-03-22T01:33:17.642Z",
  "updated_at": "2025-03-22T01:33:17.642Z"
}

success

Save a new Screen Category

post

Store a newly created Screen Category in storage

Authorizations

Body

namestringoptional

Represents a business screen category definition.

statusstring · enumoptional

Options: ACTIVE, INACTIVE

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/screen_categories' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "status": "ACTIVE"
  }'

201

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-03-22T01:33:17.642Z",
  "updated_at": "2025-03-22T01:33:17.642Z"
}

success

Update a screen Category

put

Updates the current element

Authorizations

Path parameters

screen_category_idstringrequired

ID of screen category to return

Body

namestringoptional

Represents a business screen category definition.

statusstring · enumoptional

Options: ACTIVE, INACTIVE

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/screen_categories/{screen_category_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "status": "ACTIVE"
  }'

200

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-03-22T01:33:17.642Z",
  "updated_at": "2025-03-22T01:33:17.642Z"
}

success

Save a new screens

post

Create a new Screen.

Authorizations

Body

titlestringoptional

Class Screen

typestringoptional

descriptionstringoptional

configobject[]optional

computedobject[]optional

watchersobject[]optional

custom_cssstringoptional

screen_category_idstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/screens' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "type": "text",
    "description": "text",
    "config": [
      {}
    ],
    "computed": [
      {}
    ],
    "watchers": [
      {}
    ],
    "custom_css": "text",
    "screen_category_id": "text"
  }'

201

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [
    {}
  ],
  "computed": [
    {}
  ],
  "watchers": [
    {}
  ],
  "custom_css": "text",
  "screen_category_id": "text",
  "id": "text",
  "created_at": "2025-03-22T01:33:17.642Z",
  "updated_at": "2025-03-22T01:33:17.642Z"
}

success

Update a screen

put

Update a Screen.

Authorizations

Path parameters

screens_idstringrequired

ID of screen to return

Body

titlestringoptional

Class Screen

typestringoptional

descriptionstringoptional

configobject[]optional

computedobject[]optional

watchersobject[]optional

custom_cssstringoptional

screen_category_idstringoptional

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/screens/{screens_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "type": "text",
    "description": "text",
    "config": [
      {}
    ],
    "computed": [
      {}
    ],
    "watchers": [
      {}
    ],
    "custom_css": "text",
    "screen_category_id": "text"
  }'

204

No body

success

duplicate a screen

put

duplicate a Screen.

Authorizations

Path parameters

screens_idstringrequired

ID of screen to return

Body

titlestringoptional

Class Screen

typestringoptional

descriptionstringoptional

configobject[]optional

computedobject[]optional

watchersobject[]optional

custom_cssstringoptional

screen_category_idstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/screens/{screens_id}/duplicate' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "type": "text",
    "description": "text",
    "config": [
      {}
    ],
    "computed": [
      {}
    ],
    "watchers": [
      {}
    ],
    "custom_css": "text",
    "screen_category_id": "text"
  }'

201

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [
    {}
  ],
  "computed": [
    {}
  ],
  "watchers": [
    {}
  ],
  "custom_css": "text",
  "screen_category_id": "text",
  "id": "text",
  "created_at": "2025-03-22T01:33:17.642Z",
  "updated_at": "2025-03-22T01:33:17.642Z"
}

success

Import a new screen

post

Import the specified screen.

Authorizations

Body

filestring · binaryoptional

file to import

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/screens/import' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=binary'

201

{
  "status": {}
}

success

Preview a screen

post

Get preview a screen

Authorizations

Body

configobjectoptional

watchersobjectoptional

computedobjectoptional

custom_cssstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/screens/preview' \
  --header 'Content-Type: application/json' \
  --data '{
    "config": {},
    "watchers": {},
    "computed": {},
    "custom_css": "text"
  }'

200

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [
    {}
  ],
  "computed": [
    {}
  ],
  "watchers": [
    {}
  ],
  "custom_css": "text",
  "screen_category_id": "text",
  "id": "text",
  "created_at": "2025-03-22T01:33:17.642Z",
  "updated_at": "2025-03-22T01:33:17.642Z"
}

Successfully found the screen