processmaker.com Knowledge Center ProcessMaker University

Screens

API Reference for ProcessMaker Screen API

PreviousProcesses NextEnvironment Variables

Last updated 4 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

all ofOptional

get

GET /api/1.0/screen_categories/{screen_category_id} HTTP/1.1
Host: 
Accept: */*

200

Successfully found the screen

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-04-19T09:55:58.204Z",
  "updated_at": "2025-04-19T09:55:58.204Z"
}

Delete a screen category

delete

Remove the specified resource from storage.

Authorizations

Path parameters

screen_category_idstringRequired

ID of screen category to return

Responses

delete

DELETE /api/1.0/screen_categories/{screen_category_id} HTTP/1.1
Host: 
Accept: */*

204

success

No content

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 · enumOptionalDefault: ascAvailable options:

per_pageintegerOptionalDefault: 10

includestringOptional

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

Default: ""

excludestringOptional

Comma separated list of fields to exclude from the response

Default: ""

Responses

application/json

objectOptional

get

GET /api/1.0/screens HTTP/1.1
Host: 
Accept: */*

200

list of screens

{
  "data": [
    {
      "title": "text",
      "type": "text",
      "description": "text",
      "config": [
        {}
      ],
      "computed": [
        {}
      ],
      "watchers": [
        {}
      ],
      "custom_css": "text",
      "screen_category_id": "text",
      "id": "text",
      "created_at": "2025-04-19T09:55:58.204Z",
      "updated_at": "2025-04-19T09:55:58.204Z"
    }
  ],
  "meta": {}
}

Get single screens by ID

get

Get a single Screen.

Authorizations

Path parameters

screens_idstringRequired

ID of screens to return

Responses

application/json

all ofOptional

get

GET /api/1.0/screens/{screens_id} HTTP/1.1
Host: 
Accept: */*

200

Successfully found the screen

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [
    {}
  ],
  "computed": [
    {}
  ],
  "watchers": [
    {}
  ],
  "custom_css": "text",
  "screen_category_id": "text",
  "id": "text",
  "created_at": "2025-04-19T09:55:58.204Z",
  "updated_at": "2025-04-19T09:55:58.204Z"
}

Delete a screen

delete

Delete a Screen.

Authorizations

Path parameters

screens_idstringRequired

ID of screen to return

Responses

delete

DELETE /api/1.0/screens/{screens_id} HTTP/1.1
Host: 
Accept: */*

204

success

No content

Export a single screen by ID

post

Export the specified screen.

Authorizations

Path parameters

screensIdstringRequired

ID of screen to return

Responses

application/json

objectOptional

post

POST /api/1.0/screens/{screensId}/export HTTP/1.1
Host: 
Accept: */*

200

Successfully exported the screen

{
  "url": "text"
}

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 · enumOptionalDefault: ascAvailable options:

per_pageintegerOptionalDefault: 10

Responses

application/json

objectOptional

get

GET /api/1.0/screen_categories HTTP/1.1
Host: 
Accept: */*

200

list of screens categories

{
  "data": [
    {
      "name": "text",
      "status": "ACTIVE",
      "id": "text",
      "created_at": "2025-04-19T09:55:58.204Z",
      "updated_at": "2025-04-19T09:55:58.204Z"
    }
  ],
  "meta": {}
}

Create or update a new setting

post

Create a new Settings css-override

Authorizations

Body

variablesstringOptional

sansSerifFontstringOptional

Responses

application/json

all ofOptional

post

POST /api/1.0/customize-ui HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "variables": "text",
  "sansSerifFont": "text"
}

201

success

{
  "key": "text",
  "config": [
    {}
  ],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": true,
  "readonly": true,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-04-19T09:55:58.204Z",
  "updated_at": "2025-04-19T09:55:58.204Z"
}

Save a new Screen Category

post

Store a newly created Screen Category in storage

Authorizations

Body

namestringOptional

Represents a business screen category definition.

statusstring · enumOptionalAvailable options:

Responses

application/json

all ofOptional

post

POST /api/1.0/screen_categories HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "name": "text",
  "status": "ACTIVE"
}

201

success

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-04-19T09:55:58.204Z",
  "updated_at": "2025-04-19T09:55:58.204Z"
}

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 · enumOptionalAvailable options:

Responses

application/json

all ofOptional

put

PUT /api/1.0/screen_categories/{screen_category_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "name": "text",
  "status": "ACTIVE"
}

200

success

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-04-19T09:55:58.204Z",
  "updated_at": "2025-04-19T09:55:58.204Z"
}

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

all ofOptional

post

POST /api/1.0/screens HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 145

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [
    {}
  ],
  "computed": [
    {}
  ],
  "watchers": [
    {}
  ],
  "custom_css": "text",
  "screen_category_id": "text"
}

201

success

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [
    {}
  ],
  "computed": [
    {}
  ],
  "watchers": [
    {}
  ],
  "custom_css": "text",
  "screen_category_id": "text",
  "id": "text",
  "created_at": "2025-04-19T09:55:58.204Z",
  "updated_at": "2025-04-19T09:55:58.204Z"
}

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

put

PUT /api/1.0/screens/{screens_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 145

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [
    {}
  ],
  "computed": [
    {}
  ],
  "watchers": [
    {}
  ],
  "custom_css": "text",
  "screen_category_id": "text"
}

204

success

No content

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

all ofOptional

put

PUT /api/1.0/screens/{screens_id}/duplicate HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 145

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [
    {}
  ],
  "computed": [
    {}
  ],
  "watchers": [
    {}
  ],
  "custom_css": "text",
  "screen_category_id": "text"
}

201

success

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [
    {}
  ],
  "computed": [
    {}
  ],
  "watchers": [
    {}
  ],
  "custom_css": "text",
  "screen_category_id": "text",
  "id": "text",
  "created_at": "2025-04-19T09:55:58.204Z",
  "updated_at": "2025-04-19T09:55:58.204Z"
}

Import a new screen

post

Import the specified screen.

Authorizations

Body

filestring · binaryOptional

file to import

Responses

application/json

objectOptional

post

POST /api/1.0/screens/import HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

201

success

{
  "status": {}
}

Preview a screen

post

Get preview a screen

Authorizations

Body

configobjectOptional

watchersobjectOptional

computedobjectOptional

custom_cssstringOptional

Responses

application/json

all ofOptional

post

POST /api/1.0/screens/preview HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "config": {},
  "watchers": {},
  "computed": {},
  "custom_css": "text"
}

200

Successfully found the screen

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [
    {}
  ],
  "computed": [
    {}
  ],
  "watchers": [
    {}
  ],
  "custom_css": "text",
  "screen_category_id": "text",
  "id": "text",
  "created_at": "2025-04-19T09:55:58.204Z",
  "updated_at": "2025-04-19T09:55:58.204Z"
}