Scripts

API Reference for ProcessMaker Script API

Returns all scripts categories that the user has access to

Display a listing of the Script Categories.

GET/api/1.0/script_categories

Query parameters

Response

list of scripts categories

Body

dataarray of ScriptCategory (all of)

metaobject

Request

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

Response

{
  "data": [
    {
      "name": "text",
      "status": "ACTIVE",
      "id": "text",
      "created_at": "2024-05-11T11:19:11.597Z",
      "updated_at": "2024-05-11T11:19:11.597Z"
    }
  ]
}

Save a new Script Category

Store a newly created Script Category in storage

POST/api/1.0/script_categories

Body

namestring

Represents a business script category definition.

statusenum

ACTIVEINACTIVE

Response

success

Body

namestring

Represents a business script category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/script_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-11T11:19:11.597Z",
  "updated_at": "2024-05-11T11:19:11.597Z"
}

Get single script category by ID

Display the specified script category.

GET/api/1.0/script_categories/{script_category_id}

Path parameters

script_category_id*string

ID of script category to return

Response

Successfully found the script

Body

namestring

Represents a business script category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

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

Response

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2024-05-11T11:19:11.597Z",
  "updated_at": "2024-05-11T11:19:11.597Z"
}

Update a script Category

Updates the current element

PUT/api/1.0/script_categories/{script_category_id}

Path parameters

script_category_id*string

ID of script category to return

Body

namestring

Represents a business script category definition.

statusenum

ACTIVEINACTIVE

Response

success

Body

namestring

Represents a business script category definition.

statusenum

ACTIVEINACTIVE

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

const response = await fetch('/api/1.0/script_categories/{script_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-11T11:19:11.597Z",
  "updated_at": "2024-05-11T11:19:11.597Z"
}

Delete a script category

Remove the specified resource from storage.

DELETE/api/1.0/script_categories/{script_category_id}

Path parameters

script_category_id*string

ID of script category to return

Response

success

Request

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

Returns all scripts that the user has access to

Get a list of scripts in a process.

GET/api/1.0/scripts

Query parameters

Response

list of scripts

Body

dataarray of scripts (all of)

metaobject

Request

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

Response

{
  "data": [
    {
      "title": "text",
      "description": "text",
      "language": "text",
      "code": "text",
      "key": "text",
      "created_at": "2024-05-11T11:19:11.597Z",
      "updated_at": "2024-05-11T11:19:11.597Z"
    }
  ]
}

Save a new script

Create a new script in a process.

POST/api/1.0/scripts

Body

titlestring

Represents an Eloquent model of a Script

descriptionstring

languagestring

codestring

timeoutinteger

run_as_user_idinteger

keystring

script_category_idinteger

Response

success

Body

titlestring

Represents an Eloquent model of a Script

descriptionstring

languagestring

codestring

timeoutinteger

run_as_user_idinteger

keystring

script_category_idinteger

idinteger (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

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

Response

{
  "title": "text",
  "description": "text",
  "language": "text",
  "code": "text",
  "key": "text",
  "created_at": "2024-05-11T11:19:11.597Z",
  "updated_at": "2024-05-11T11:19:11.597Z"
}

Test script code without saving it

Previews executing a script, with sample data/config data

POST/api/1.0/scripts/{script_id}/preview

Path parameters

script_id*integer

Body

dataarray of object

configarray of object

codestring

noncestring

Response

success if the script was queued

Request

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

Execute script

Executes a script, with sample data/config data

POST/api/1.0/scripts/execute/{script_id}

Path parameters

script_id*integer

Body

dataarray of object

configarray of object

Response

success if the script was queued

Body

statusstring

keystring

Request

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

Response

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

Get the response of a script execution by execution key

Get the response of a script execution

GET/api/1.0/scripts/execution/{key}

Path parameters

key*string

Response

response of a script execution

Body

any

Request

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

Get single script by ID

Get a single script in a process.

GET/api/1.0/scripts/{script_id}

Path parameters

script_id*string

ID of script to return

Response

Successfully found the script

Body

titlestring

Represents an Eloquent model of a Script

descriptionstring

languagestring

codestring

timeoutinteger

run_as_user_idinteger

keystring

script_category_idinteger

idinteger (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

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

Response

{
  "title": "text",
  "description": "text",
  "language": "text",
  "code": "text",
  "key": "text",
  "created_at": "2024-05-11T11:19:11.597Z",
  "updated_at": "2024-05-11T11:19:11.597Z"
}

Update a script

Update a script in a process.

PUT/api/1.0/scripts/{script_id}

Path parameters

script_id*string

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

Response

success

Request

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

Delete a script

Delete a script in a process.

DELETE/api/1.0/scripts/{script_id}

Path parameters

script_id*string

ID of script to return

Response

success

Request

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

duplicate a script

duplicate a Script.

PUT/api/1.0/scripts/{scripts_id}/duplicate

Path parameters

scripts_id*string

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

Response

success

Body

titlestring

Represents an Eloquent model of a Script

descriptionstring

languagestring

codestring

timeoutinteger

run_as_user_idinteger

keystring

script_category_idinteger

idinteger (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

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

Response

{
  "title": "text",
  "description": "text",
  "language": "text",
  "code": "text",
  "key": "text",
  "created_at": "2024-05-11T11:19:11.597Z",
  "updated_at": "2024-05-11T11:19:11.597Z"
}

Returns all script executors that the user has access to

Get a list of script executors.

GET/api/1.0/script-executors

Query parameters

Response

list of script executors

Body

dataarray of scriptExecutors (all of)

metaobject

Request

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

Response

{
  "data": [
    {
      "title": "text",
      "description": "text",
      "language": "text",
      "config": "text",
      "created_at": "2024-05-11T11:19:11.597Z",
      "updated_at": "2024-05-11T11:19:11.597Z"
    }
  ]
}

Create a script executor

POST/api/1.0/script-executors

Body

titlestring

Represents an Eloquent model of a Script Executor

descriptionstring

languagestring

configstring

Response

success

Body

statusstring

idstring

Request

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

Response

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

Update script executor

Update and rebuild the script executor

PUT/api/1.0/script-executors/{script_executor}

Path parameters

script_executor*string

ID of script executor to return

Body

titlestring

Represents an Eloquent model of a Script Executor

descriptionstring

languagestring

configstring

Response

success

Body

statusstring

Request

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

Response

{
  "status": "text"
}

Delete a script executor

DELETE/api/1.0/script-executors/{script_executor}

Path parameters

script_executor*string

ID of script executor to return

Response

success

Body

statusstring

Request

const response = await fetch('/api/1.0/script-executors/{script_executor}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "status": "text"
}

Cancel a script executor

POST/api/1.0/script-executors/cancel

Body

pidFilestring

Response

success

Body

statusstring

idstring

Request

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

Response

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

Returns all available languages

Get a list of available languages.

GET/api/1.0/script-executors/available-languages

Query parameters

Response

list of available languages

Body

dataarray of availableLanguages (object)

metaobject

Request

const response = await fetch('/api/1.0/script-executors/available-languages', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Last updated 11 months ago