Scripts

API Reference for ProcessMaker Script API

Returns all scripts categories that the user has access to

get

Display a listing of the Script Categories.

Authorizations

passportbearer

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

Available options:

per_pageinteger · default: "10"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "data": [
    {
      "name": "text",
      "status": "ACTIVE",
      "id": "text",
      "created_at": "2025-04-02T07:35:07.335Z",
      "updated_at": "2025-04-02T07:35:07.335Z"
    }
  ],
  "meta": {}
}

list of scripts categories

Save a new Script Category

post

Store a newly created Script Category in storage

Authorizations

passportbearer

Body

namestringoptional

Represents a business script category definition.

statusstring · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

201

201

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-04-02T07:35:07.335Z",
  "updated_at": "2025-04-02T07:35:07.335Z"
}

success

Get single script category by ID

get

Display the specified script category.

Authorizations

passportbearer

Path parameters

script_category_idstringrequired

ID of script category to return

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-04-02T07:35:07.335Z",
  "updated_at": "2025-04-02T07:35:07.335Z"
}

Successfully found the script

Update a script Category

put

Updates the current element

Authorizations

passportbearer

Path parameters

script_category_idstringrequired

ID of script category to return

Body

namestringoptional

Represents a business script category definition.

statusstring · enumoptional

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-04-02T07:35:07.335Z",
  "updated_at": "2025-04-02T07:35:07.335Z"
}

success

Delete a script category

delete

Remove the specified resource from storage.

Authorizations

passportbearer

Path parameters

script_category_idstringrequired

ID of script category to return

Responses

cURL

JavaScript

Python

HTTP

cURL

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

204

204

No body

success

Returns all scripts that the user has access to

get

Get a list of scripts in a process.

Authorizations

passportbearer

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

Available options:

per_pageinteger · default: "10"optional

includestring · default: ""optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "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-04-02T07:35:07.335Z",
      "updated_at": "2025-04-02T07:35:07.335Z"
    }
  ],
  "meta": {}
}

list of scripts

Save a new script

post

Create a new script in a process.

Authorizations

passportbearer

Body

titlestringoptional

Represents an Eloquent model of a Script

descriptionstringoptional

languagestringoptional

codestringoptional

timeoutintegeroptional

run_as_user_idintegeroptional

keystringoptional

script_category_idintegeroptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/scripts' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "description": "text",
    "language": "text",
    "code": "text",
    "timeout": 1,
    "run_as_user_id": 1,
    "key": "text",
    "script_category_id": 1
  }'

201

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-04-02T07:35:07.335Z",
  "updated_at": "2025-04-02T07:35:07.335Z"
}

success

Test script code without saving it

post

Previews executing a script, with sample data/config data

Authorizations

passportbearer

Path parameters

script_idintegerrequired

Body

dataobject[]optional

configobject[]optional

codestringoptional

noncestringoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

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

200

200

No body

success if the script was queued

Execute script

post

Executes a script, with sample data/config data

Authorizations

passportbearer

Path parameters

script_idintegerrequired

Body

dataobject[]optional

configobject[]optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

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

success if the script was queued

Get the response of a script execution by execution key

get

Get the response of a script execution

Authorizations

passportbearer

Path parameters

keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

No body

response of a script execution

Get single script by ID

get

Get a single script in a process.

Authorizations

passportbearer

Path parameters

script_idstringrequired

ID of script to return

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

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-04-02T07:35:07.335Z",
  "updated_at": "2025-04-02T07:35:07.335Z"
}

Successfully found the script

Update a script

put

Update a script in a process.

Authorizations

passportbearer

Path parameters

script_idstringrequired

ID of script to return

Body

titlestringoptional

Represents an Eloquent model of a Script

descriptionstringoptional

languagestringoptional

codestringoptional

timeoutintegeroptional

run_as_user_idintegeroptional

keystringoptional

script_category_idintegeroptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/1.0/scripts/{script_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "description": "text",
    "language": "text",
    "code": "text",
    "timeout": 1,
    "run_as_user_id": 1,
    "key": "text",
    "script_category_id": 1
  }'

204

204

No body

success

Delete a script

delete

Delete a script in a process.

Authorizations

passportbearer

Path parameters

script_idstringrequired

ID of script to return

Responses

cURL

JavaScript

Python

HTTP

cURL

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

204

204

No body

success

duplicate a script

put

duplicate a Script.

Authorizations

passportbearer

Path parameters

scripts_idstringrequired

ID of script to return

Body

titlestringoptional

Represents an Eloquent model of a Script

descriptionstringoptional

languagestringoptional

codestringoptional

timeoutintegeroptional

run_as_user_idintegeroptional

keystringoptional

script_category_idintegeroptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/1.0/scripts/{scripts_id}/duplicate' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "description": "text",
    "language": "text",
    "code": "text",
    "timeout": 1,
    "run_as_user_id": 1,
    "key": "text",
    "script_category_id": 1
  }'

201

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-04-02T07:35:07.335Z",
  "updated_at": "2025-04-02T07:35:07.335Z"
}

success

Returns all script executors that the user has access to

get

Get a list of script executors.

Authorizations

passportbearer

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

Available options:

per_pageinteger · default: "10"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "data": [
    {
      "title": "text",
      "description": "text",
      "language": "text",
      "config": "text",
      "id": 1,
      "created_at": "2025-04-02T07:35:07.335Z",
      "updated_at": "2025-04-02T07:35:07.335Z"
    }
  ],
  "meta": {}
}

list of script executors

Create a script executor

post

Create a script executor

Authorizations

passportbearer

Body

titlestringoptional

Represents an Eloquent model of a Script Executor

descriptionstringoptional

languagestringoptional

configstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/script-executors' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "description": "text",
    "language": "text",
    "config": "text"
  }'

200

200

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

success

Update script executor

put

Update and rebuild the script executor

Authorizations

passportbearer

Path parameters

script_executorstringrequired

ID of script executor to return

Body

titlestringoptional

Represents an Eloquent model of a Script Executor

descriptionstringoptional

languagestringoptional

configstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/1.0/script-executors/{script_executor}' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "description": "text",
    "language": "text",
    "config": "text"
  }'

200

200

{
  "status": "text"
}

success

Delete a script executor

delete

Delete a script executor

Authorizations

passportbearer

Path parameters

script_executorstringrequired

ID of script executor to return

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "status": "text"
}

success

Cancel a script executor

post

Cancel a script executor

Authorizations

passportbearer

Body

pidFilestringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/script-executors/cancel' \
  --header 'Content-Type: application/json' \
  --data '{
    "pidFile": "text"
  }'

200

200

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

success

Returns all available languages

get

Get a list of available languages.

Authorizations

passportbearer

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

Available options:

per_pageinteger · default: "10"optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

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

list of available languages