Screens

API Reference for ProcessMaker Screen API

Create or update a new setting

Create a new Settings css-override

POST/api/1.0/customize-ui

Body

application/json

variablesstring

sansSerifFontstring

Response

201

success

Body

application/json

keystring

Class Settings

configarray of object

namestring

helperstring

groupstring

formatstring

hiddenboolean

readonlyboolean

variablesstring

sansSerifFontstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurl

const response = await fetch('/api/1.0/customize-ui', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "key": "text",
  "config": [],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": false,
  "readonly": false,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2024-05-11T16:10:35.259Z",
  "updated_at": "2024-05-11T16:10:35.259Z"
}

Returns all screens categories that the user has access to

Display a listing of the Screen Categories.

GET/api/1.0/screen_categories

Query parameters

Response

200

list of screens categories

Body

application/json

dataarray of ScreenCategory (all of)

metaobject

Request

JavaScriptCurl

const response = await fetch('/api/1.0/screen_categories', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "name": "text",
      "status": "ACTIVE",
      "id": "text",
      "created_at": "2024-05-11T16:10:35.259Z",
      "updated_at": "2024-05-11T16:10:35.259Z"
    }
  ]
}

Save a new Screen Category

Store a newly created Screen Category in storage

POST/api/1.0/screen_categories

Body

application/json

namestring

Represents a business screen category definition.

statusenum

ACTIVEINACTIVE

Response

201

success

Body

application/json

namestring

Represents a business screen category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurl

const response = await fetch('/api/1.0/screen_categories', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2024-05-11T16:10:35.259Z",
  "updated_at": "2024-05-11T16:10:35.259Z"
}

Get single screen category by ID

Display the specified screen category.

GET/api/1.0/screen_categories/{screen_category_id}

Path parameters

screen_category_id*string

ID of screen category to return

Response

200

Successfully found the screen

Body

application/json

namestring

Represents a business screen category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurl

const response = await fetch('/api/1.0/screen_categories/{screen_category_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2024-05-11T16:10:35.259Z",
  "updated_at": "2024-05-11T16:10:35.259Z"
}

Update a screen Category

Updates the current element

PUT/api/1.0/screen_categories/{screen_category_id}

Path parameters

screen_category_id*string

ID of screen category to return

Body

application/json

namestring

Represents a business screen category definition.

statusenum

ACTIVEINACTIVE

Response

200

success

Body

application/json

namestring

Represents a business screen category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurl

const response = await fetch('/api/1.0/screen_categories/{screen_category_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2024-05-11T16:10:35.259Z",
  "updated_at": "2024-05-11T16:10:35.259Z"
}

Delete a screen category

Remove the specified resource from storage.

DELETE/api/1.0/screen_categories/{screen_category_id}

Path parameters

screen_category_id*string

ID of screen category to return

Response

204

success

Request

JavaScriptCurl

const response = await fetch('/api/1.0/screen_categories/{screen_category_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Returns all screens that the user has access to

Get a list of Screens.

GET/api/1.0/screens

Query parameters

Response

200

list of screens

Body

application/json

dataarray of screens (all of)

metaobject

Request

JavaScriptCurl

const response = await fetch('/api/1.0/screens', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "title": "text",
      "type": "text",
      "description": "text",
      "config": [],
      "computed": [],
      "watchers": [],
      "custom_css": "text",
      "screen_category_id": "text",
      "id": "text",
      "created_at": "2024-05-11T16:10:35.259Z",
      "updated_at": "2024-05-11T16:10:35.259Z"
    }
  ]
}

Save a new screens

Create a new Screen.

POST/api/1.0/screens

Body

application/json

titlestring

Class Screen

typestring

descriptionstring

configarray of object

computedarray of object

watchersarray of object

custom_cssstring

screen_category_idstring

Response

201

success

Body

application/json

titlestring

Class Screen

typestring

descriptionstring

configarray of object

computedarray of object

watchersarray of object

custom_cssstring

screen_category_idstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurl

const response = await fetch('/api/1.0/screens', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [],
  "computed": [],
  "watchers": [],
  "custom_css": "text",
  "screen_category_id": "text",
  "id": "text",
  "created_at": "2024-05-11T16:10:35.259Z",
  "updated_at": "2024-05-11T16:10:35.259Z"
}

Get single screens by ID

Get a single Screen.

GET/api/1.0/screens/{screens_id}

Path parameters

screens_id*string

ID of screens to return

Response

200

Successfully found the screen

Body

application/json

titlestring

Class Screen

typestring

descriptionstring

configarray of object

computedarray of object

watchersarray of object

custom_cssstring

screen_category_idstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurl

const response = await fetch('/api/1.0/screens/{screens_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [],
  "computed": [],
  "watchers": [],
  "custom_css": "text",
  "screen_category_id": "text",
  "id": "text",
  "created_at": "2024-05-11T16:10:35.259Z",
  "updated_at": "2024-05-11T16:10:35.259Z"
}

Update a screen

Update a Screen.

PUT/api/1.0/screens/{screens_id}

Path parameters

screens_id*string

ID of screen to return

Body

application/json

titlestring

Class Screen

typestring

descriptionstring

configarray of object

computedarray of object

watchersarray of object

custom_cssstring

screen_category_idstring

Response

204

success

Request

JavaScriptCurl

const response = await fetch('/api/1.0/screens/{screens_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Delete a screen

Delete a Screen.

DELETE/api/1.0/screens/{screens_id}

Path parameters

screens_id*string

ID of screen to return

Response

204

success

Request

JavaScriptCurl

const response = await fetch('/api/1.0/screens/{screens_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

duplicate a screen

duplicate a Screen.

PUT/api/1.0/screens/{screens_id}/duplicate

Path parameters

screens_id*string

ID of screen to return

Body

application/json

titlestring

Class Screen

typestring

descriptionstring

configarray of object

computedarray of object

watchersarray of object

custom_cssstring

screen_category_idstring

Response

201

success

Body

application/json

titlestring

Class Screen

typestring

descriptionstring

configarray of object

computedarray of object

watchersarray of object

custom_cssstring

screen_category_idstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurl

const response = await fetch('/api/1.0/screens/{screens_id}/duplicate', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [],
  "computed": [],
  "watchers": [],
  "custom_css": "text",
  "screen_category_id": "text",
  "id": "text",
  "created_at": "2024-05-11T16:10:35.259Z",
  "updated_at": "2024-05-11T16:10:35.259Z"
}

Export a single screen by ID

Export the specified screen.

POST/api/1.0/screens/{screensId}/export

Path parameters

screensId*string

ID of screen to return

Response

200

Successfully exported the screen

Body

application/json

urlstring

Request

JavaScriptCurl

const response = await fetch('/api/1.0/screens/{screensId}/export', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "url": "text"
}

Import a new screen

Import the specified screen.

POST/api/1.0/screens/import

Body

multipart/form-data

filestring (binary)

file to import

Response

201

success

Body

application/json

statusobject

Request

JavaScriptCurl

const response = await fetch('/api/1.0/screens/import', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{}

Preview a screen

Get preview a screen

POST/api/1.0/screens/preview

Body

application/json

configobject

watchersobject

computedobject

custom_cssstring

Response

200

Successfully found the screen

Body

application/json

titlestring

Class Screen

typestring

descriptionstring

configarray of object

computedarray of object

watchersarray of object

custom_cssstring

screen_category_idstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurl

const response = await fetch('/api/1.0/screens/preview', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "title": "text",
  "type": "text",
  "description": "text",
  "config": [],
  "computed": [],
  "watchers": [],
  "custom_css": "text",
  "screen_category_id": "text",
  "id": "text",
  "created_at": "2024-05-11T16:10:35.259Z",
  "updated_at": "2024-05-11T16:10:35.259Z"
}