processmaker.com Knowledge Center ProcessMaker University

Scripts

API Reference for ProcessMaker Script API

PreviousNotifications NextAdministrative APIs

Last updated 2 months ago

Was this helpful?

Returns all scripts categories that the user has access to

Display a listing of the Script Categories.

get

/script_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/script_categories'

200

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

list of scripts categories

Save a new Script Category

Store a newly created Script Category in storage

post

/script_categories

Authorizations

Body

namestring

Represents a business script category definition.

statusstring · enum

Options: ACTIVE, INACTIVE

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

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

success

Get single script category by ID

Display the specified script category.

get

/script_categories/{script_category_id}

Authorizations

Path parameters

script_category_idstringrequired

ID of script category to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/script_categories/{script_category_id}'

200

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

Successfully found the script

Update a script Category

Updates the current element

put

/script_categories/{script_category_id}

Authorizations

Path parameters

script_category_idstringrequired

ID of script category to return

Body

namestring

Represents a business script category definition.

statusstring · enum

Options: ACTIVE, INACTIVE

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/script_categories/{script_category_id}' \
  --header 'Content-Type: application/json' \
  --data '{"status":"ACTIVE"}'

200

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

success

Delete a script category

Remove the specified resource from storage.

delete

/script_categories/{script_category_id}

Authorizations

Path parameters

script_category_idstringrequired

ID of script category to return

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/1.0/script_categories/{script_category_id}'

204

No body

success

Returns all scripts that the user has access to

Get a list of scripts in a process.

get

/scripts

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/scripts'

200

{
  "meta": {},
  "data": [
    {
      "title": "text",
      "description": "text",
      "language": "text",
      "code": "text",
      "timeout": 1,
      "run_as_user_id": 1,
      "key": "text",
      "script_category_id": 1,
      "id": 1,
      "created_at": "2025-02-20T19:07:23.944Z",
      "updated_at": "2025-02-20T19:07:23.944Z"
    }
  ]
}

list of scripts

Save a new script

Create a new script in a process.

post

/scripts

Authorizations

Body

titlestring

Represents an Eloquent model of a Script

descriptionstring

languagestring

codestring

timeoutinteger

run_as_user_idinteger

keystring

script_category_idinteger

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

{
  "title": "text",
  "description": "text",
  "language": "text",
  "code": "text",
  "timeout": 1,
  "run_as_user_id": 1,
  "key": "text",
  "script_category_id": 1,
  "id": 1,
  "created_at": "2025-02-20T19:07:23.944Z",
  "updated_at": "2025-02-20T19:07:23.944Z"
}

success

Test script code without saving it

Previews executing a script, with sample data/config data

post

/scripts/{script_id}/preview

Authorizations

Path parameters

script_idintegerrequired

Body

codestring

noncestring

dataobject[]

configobject[]

Responses

cURL

JavaScript

Python

HTTP

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

200

No body

success if the script was queued

Execute script

Executes a script, with sample data/config data

post

/scripts/execute/{script_id}

Authorizations

Path parameters

script_idintegerrequired

Body

dataobject[]

configobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "status": "text",
  "key": "text"
}

success if the script was queued

Get the response of a script execution by execution key

Get the response of a script execution

get

/scripts/execution/{key}

Authorizations

Path parameters

keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/scripts/execution/{key}'

200

No body

response of a script execution

Get single script by ID

Get a single script in a process.

get

/scripts/{script_id}

Authorizations

Path parameters

script_idstringrequired

ID of script to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/scripts/{script_id}'

200

{
  "title": "text",
  "description": "text",
  "language": "text",
  "code": "text",
  "timeout": 1,
  "run_as_user_id": 1,
  "key": "text",
  "script_category_id": 1,
  "id": 1,
  "created_at": "2025-02-20T19:07:23.944Z",
  "updated_at": "2025-02-20T19:07:23.944Z"
}

Successfully found the script

Update a script

Update a script in a process.

put

/scripts/{script_id}

Authorizations

Path parameters

script_idstringrequired

ID of script to return

Body

titlestring

Represents an Eloquent model of a Script

descriptionstring

languagestring

codestring

timeoutinteger

run_as_user_idinteger

keystring

script_category_idinteger

Responses

cURL

JavaScript

Python

HTTP

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

204

No body

success

Delete a script

Delete a script in a process.

delete

/scripts/{script_id}

Authorizations

Path parameters

script_idstringrequired

ID of script to return

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/1.0/scripts/{script_id}'

204

No body

success

duplicate a script

duplicate a Script.

put

/scripts/{scripts_id}/duplicate

Authorizations

Path parameters

scripts_idstringrequired

ID of script to return

Body

titlestring

Represents an Eloquent model of a Script

descriptionstring

languagestring

codestring

timeoutinteger

run_as_user_idinteger

keystring

script_category_idinteger

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/scripts/{scripts_id}/duplicate' \
  --header 'Content-Type: application/json'

201

{
  "title": "text",
  "description": "text",
  "language": "text",
  "code": "text",
  "timeout": 1,
  "run_as_user_id": 1,
  "key": "text",
  "script_category_id": 1,
  "id": 1,
  "created_at": "2025-02-20T19:07:23.944Z",
  "updated_at": "2025-02-20T19:07:23.944Z"
}

success

Returns all script executors that the user has access to

Get a list of script executors.

get

/script-executors

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/script-executors'

200

{
  "meta": {},
  "data": [
    {
      "title": "text",
      "description": "text",
      "language": "text",
      "config": "text",
      "id": 1,
      "created_at": "2025-02-20T19:07:23.944Z",
      "updated_at": "2025-02-20T19:07:23.944Z"
    }
  ]
}

list of script executors

Create a script executor

post

/script-executors

Authorizations

Body

titlestring

Represents an Eloquent model of a Script Executor

descriptionstring

languagestring

configstring

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "status": "text",
  "id": "text"
}

success

Update script executor

Update and rebuild the script executor

put

/script-executors/{script_executor}

Authorizations

Path parameters

script_executorstringrequired

ID of script executor to return

Body

titlestring

Represents an Eloquent model of a Script Executor

descriptionstring

languagestring

configstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/1.0/script-executors/{script_executor}' \
  --header 'Content-Type: application/json'

200

{
  "status": "text"
}

success

Delete a script executor

delete

/script-executors/{script_executor}

Authorizations

Path parameters

script_executorstringrequired

ID of script executor to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/1.0/script-executors/{script_executor}'

200

{
  "status": "text"
}

success

Cancel a script executor

post

/script-executors/cancel

Authorizations

Body

pidFilestring

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "status": "text",
  "id": "text"
}

success

Returns all available languages

Get a list of available languages.

get

/script-executors/available-languages

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/script-executors/available-languages'

200

{
  "meta": {},
  "data": [
    {
      "text": "text",
      "value": "text",
      "initDockerFile": "text"
    }
  ]
}

list of available languages