processmaker.com Knowledge Center ProcessMaker University

Screens

API Reference for ProcessMaker Screen API

PreviousProcesses NextEnvironment Variables

Last updated 2 months ago

Was this helpful?

Create or update a new setting

Create a new Settings css-override

post

/customize-ui

Authorizations

Body

variablesstring

sansSerifFontstring

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

{
  "key": "text",
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": true,
  "readonly": true,
  "variables": "text",
  "sansSerifFont": "text",
  "config": [
    {}
  ],
  "id": "text",
  "created_at": "2025-02-20T19:04:22.645Z",
  "updated_at": "2025-02-20T19:04:22.645Z"
}

success

Returns all screens categories that the user has access to

Display a listing of the Screen Categories.

get

/screen_categories

Authorizations

Query parameters

filterstring

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

order_bystring

Field to order results by

order_directionstring · enum · default: asc

Options: asc, desc

per_pageinteger · default: 10

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "meta": {},
  "data": [
    {
      "name": "text",
      "status": "ACTIVE",
      "id": "text",
      "created_at": "2025-02-20T19:04:22.645Z",
      "updated_at": "2025-02-20T19:04:22.645Z"
    }
  ]
}

list of screens categories

Save a new Screen Category

Store a newly created Screen Category in storage

post

/screen_categories

Authorizations

Body

namestring

Represents a business screen category definition.

statusstring · enum

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 '{"status":"ACTIVE"}'

201

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-02-20T19:04:22.645Z",
  "updated_at": "2025-02-20T19:04:22.645Z"
}

success

Get single screen category by ID

Display the specified screen category.

get

/screen_categories/{screen_category_id}

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-02-20T19:04:22.645Z",
  "updated_at": "2025-02-20T19:04:22.645Z"
}

Successfully found the screen

Update a screen Category

Updates the current element

put

/screen_categories/{screen_category_id}

Authorizations

Path parameters

screen_category_idstringrequired

ID of screen category to return

Body

namestring

Represents a business screen category definition.

statusstring · enum

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 '{"status":"ACTIVE"}'

200

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-02-20T19:04:22.645Z",
  "updated_at": "2025-02-20T19:04:22.645Z"
}

success

Delete a screen category

Remove the specified resource from storage.

delete

/screen_categories/{screen_category_id}

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 a list of Screens.

get

/screens

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.

excludestring

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

{
  "meta": {},
  "data": [
    {
      "title": "text",
      "type": "text",
      "description": "text",
      "custom_css": "text",
      "screen_category_id": "text",
      "config": [
        {}
      ],
      "computed": [
        {}
      ],
      "watchers": [
        {}
      ],
      "id": "text",
      "created_at": "2025-02-20T19:04:22.645Z",
      "updated_at": "2025-02-20T19:04:22.645Z"
    }
  ]
}

list of screens

Save a new screens

Create a new Screen.

post

/screens

Authorizations

Body

titlestring

Class Screen

typestring

descriptionstring

custom_cssstring

screen_category_idstring

configobject[]

computedobject[]

watchersobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

{
  "title": "text",
  "type": "text",
  "description": "text",
  "custom_css": "text",
  "screen_category_id": "text",
  "config": [
    {}
  ],
  "computed": [
    {}
  ],
  "watchers": [
    {}
  ],
  "id": "text",
  "created_at": "2025-02-20T19:04:22.645Z",
  "updated_at": "2025-02-20T19:04:22.645Z"
}

success

Get single screens by ID

Get a single Screen.

get

/screens/{screens_id}

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",
  "custom_css": "text",
  "screen_category_id": "text",
  "config": [
    {}
  ],
  "computed": [
    {}
  ],
  "watchers": [
    {}
  ],
  "id": "text",
  "created_at": "2025-02-20T19:04:22.645Z",
  "updated_at": "2025-02-20T19:04:22.645Z"
}

Successfully found the screen

Update a screen

Update a Screen.

put

/screens/{screens_id}

Authorizations

Path parameters

screens_idstringrequired

ID of screen to return

Body

titlestring

Class Screen

typestring

descriptionstring

custom_cssstring

screen_category_idstring

configobject[]

computedobject[]

watchersobject[]

Responses

cURL

JavaScript

Python

HTTP

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

204

No body

success

Delete a screen

Delete a Screen.

delete

/screens/{screens_id}

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

duplicate a screen

duplicate a Screen.

put

/screens/{screens_id}/duplicate

Authorizations

Path parameters

screens_idstringrequired

ID of screen to return

Body

titlestring

Class Screen

typestring

descriptionstring

custom_cssstring

screen_category_idstring

configobject[]

computedobject[]

watchersobject[]

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 '{"config":[{}],"computed":[{}],"watchers":[{}]}'

201

{
  "title": "text",
  "type": "text",
  "description": "text",
  "custom_css": "text",
  "screen_category_id": "text",
  "config": [
    {}
  ],
  "computed": [
    {}
  ],
  "watchers": [
    {}
  ],
  "id": "text",
  "created_at": "2025-02-20T19:04:22.645Z",
  "updated_at": "2025-02-20T19:04:22.645Z"
}

success

Export a single screen by ID

Export the specified screen.

post

/screens/{screensId}/export

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

Import a new screen

Import the specified screen.

post

/screens/import

Authorizations

Body

filestring · binary

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'

201

{
  "status": {}
}

success

Preview a screen

Get preview a screen

post

/screens/preview

Authorizations

Body

configobject

watchersobject

computedobject

custom_cssstring

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":{}}'

200

{
  "title": "text",
  "type": "text",
  "description": "text",
  "custom_css": "text",
  "screen_category_id": "text",
  "config": [
    {}
  ],
  "computed": [
    {}
  ],
  "watchers": [
    {}
  ],
  "id": "text",
  "created_at": "2025-02-20T19:04:22.645Z",
  "updated_at": "2025-02-20T19:04:22.645Z"
}

Successfully found the screen