Scripts
API Reference for ProcessMaker Script API
Display a listing of the Script Categories.
Filter results by string. Searches Name, Description, and Status. All fields must match exactly.
Field to order results by
asc
Possible values: 10
GET /api/1.0/script_categories HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of scripts categories
{
"data": [
{
"name": "text",
"status": "ACTIVE",
"id": "text",
"created_at": "2025-06-30T21:05:57.617Z",
"updated_at": "2025-06-30T21:05:57.617Z"
}
],
"meta": {}
}
Store a newly created Script Category in storage
Represents a business script category definition.
POST /api/1.0/script_categories HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"name": "text",
"status": "ACTIVE"
}
success
{
"name": "text",
"status": "ACTIVE",
"id": "text",
"created_at": "2025-06-30T21:05:57.617Z",
"updated_at": "2025-06-30T21:05:57.617Z"
}
Display the specified script category.
ID of script category to return
GET /api/1.0/script_categories/{script_category_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Successfully found the script
{
"name": "text",
"status": "ACTIVE",
"id": "text",
"created_at": "2025-06-30T21:05:57.617Z",
"updated_at": "2025-06-30T21:05:57.617Z"
}
Updates the current element
ID of script category to return
Represents a business script category definition.
PUT /api/1.0/script_categories/{script_category_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"name": "text",
"status": "ACTIVE"
}
success
{
"name": "text",
"status": "ACTIVE",
"id": "text",
"created_at": "2025-06-30T21:05:57.617Z",
"updated_at": "2025-06-30T21:05:57.617Z"
}
Remove the specified resource from storage.
ID of script category to return
DELETE /api/1.0/script_categories/{script_category_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
success
No content
Get a list of scripts in a process.
Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.
Field to order results by
asc
Possible values: 10
Include data from related models in payload. Comma separated list.
""
GET /api/1.0/scripts HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of scripts
{
"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-06-30T21:05:57.617Z",
"updated_at": "2025-06-30T21:05:57.617Z"
}
],
"meta": {}
}
Create a new script in a process.
Represents an Eloquent model of a Script
POST /api/1.0/scripts HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 136
{
"title": "text",
"description": "text",
"language": "text",
"code": "text",
"timeout": 1,
"run_as_user_id": 1,
"key": "text",
"script_category_id": 1
}
success
{
"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-06-30T21:05:57.617Z",
"updated_at": "2025-06-30T21:05:57.617Z"
}
Previews executing a script, with sample data/config data
POST /api/1.0/scripts/{script_id}/preview HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56
{
"data": [
{}
],
"config": [
{}
],
"code": "text",
"nonce": "text"
}
success if the script was queued
No content
Executes a script, with sample data/config data
POST /api/1.0/scripts/execute/{script_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27
{
"data": [
{}
],
"config": [
{}
]
}
success if the script was queued
{
"status": "text",
"key": "text"
}
Get the response of a script execution
GET /api/1.0/scripts/execution/{key} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
response of a script execution
No content
Get a single script in a process.
ID of script to return
GET /api/1.0/scripts/{script_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Successfully found the script
{
"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-06-30T21:05:57.617Z",
"updated_at": "2025-06-30T21:05:57.617Z"
}
Update a script in a process.
ID of script to return
Represents an Eloquent model of a Script
PUT /api/1.0/scripts/{script_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 136
{
"title": "text",
"description": "text",
"language": "text",
"code": "text",
"timeout": 1,
"run_as_user_id": 1,
"key": "text",
"script_category_id": 1
}
success
No content
duplicate a Script.
ID of script to return
Represents an Eloquent model of a Script
PUT /api/1.0/scripts/{scripts_id}/duplicate HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 136
{
"title": "text",
"description": "text",
"language": "text",
"code": "text",
"timeout": 1,
"run_as_user_id": 1,
"key": "text",
"script_category_id": 1
}
success
{
"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-06-30T21:05:57.617Z",
"updated_at": "2025-06-30T21:05:57.617Z"
}
Get a list of script executors.
Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.
Field to order results by
asc
Possible values: 10
GET /api/1.0/script-executors HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of script executors
{
"data": [
{
"title": "text",
"description": "text",
"language": "text",
"config": "text",
"id": 1,
"created_at": "2025-06-30T21:05:57.617Z",
"updated_at": "2025-06-30T21:05:57.617Z"
}
],
"meta": {}
}
Create a script executor
Represents an Eloquent model of a Script Executor
POST /api/1.0/script-executors HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71
{
"title": "text",
"description": "text",
"language": "text",
"config": "text"
}
success
{
"status": "text",
"id": "text"
}
Update and rebuild the script executor
ID of script executor to return
Represents an Eloquent model of a Script Executor
PUT /api/1.0/script-executors/{script_executor} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71
{
"title": "text",
"description": "text",
"language": "text",
"config": "text"
}
success
{
"status": "text"
}
Delete a script executor
ID of script executor to return
DELETE /api/1.0/script-executors/{script_executor} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
success
{
"status": "text"
}
Cancel a script executor
POST /api/1.0/script-executors/cancel HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"pidFile": "text"
}
success
{
"status": "text",
"id": "text"
}
Get a list of available languages.
Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.
Field to order results by
asc
Possible values: 10
GET /api/1.0/script-executors/available-languages HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of available languages
{
"data": [
{
"text": "text",
"value": "text",
"initDockerFile": "text"
}
],
"meta": {}
}
Last updated