processmaker.com Knowledge Center ProcessMaker University

Decision Engine

PreviousCollections NextSaved Search

Last updated 2 months ago

Was this helpful?

Returns all Decision Tables categories that the user has access to

Display a listing of the Decision Tables Categories.

get

/decision_table_categories

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

200

{
  "data": [
    {
      "name": "text",
      "status": "ACTIVE",
      "id": "text",
      "created_at": "2025-02-20T18:43:26.647Z",
      "updated_at": "2025-02-20T18:43:26.647Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1,
    "sort_order": "asc"
  }
}

list of Decision Tables categories

Save a new Decision Table Category

Store a newly created Decision Tables Category in storage

post

/decision_table_categories

Authorizations

Body

namestring

Represents a business decision Table category definition.

statusstring · enum

Options: ACTIVE, INACTIVE

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-02-20T18:43:26.647Z",
  "updated_at": "2025-02-20T18:43:26.647Z"
}

success

Get single Decision Table category by ID

Display the specified decision Tables category.

get

/decision_table_categories/{decision_table_categories_id}

Authorizations

Path parameters

decision_table_categories_idstringrequired

ID of Decision Table category to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/decision_table_categories/{decision_table_categories_id}'

200

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-02-20T18:43:26.647Z",
  "updated_at": "2025-02-20T18:43:26.647Z"
}

Successfully found the Decision Table

Update a Decision Table Category

Updates the current element

put

/decision_table_categories/{decision_table_categories_id}

Authorizations

Path parameters

decision_table_categories_idstringrequired

ID of Decision Table category to return

Body

namestring

Represents a business decision Table category definition.

statusstring · enum

Options: ACTIVE, INACTIVE

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-02-20T18:43:26.647Z",
  "updated_at": "2025-02-20T18:43:26.647Z"
}

success

Delete a Decision Table category

Remove the specified resource from storage.

delete

/decision_table_categories/{decision_table_categories_id}

Authorizations

Path parameters

decision_table_categories_idstringrequired

ID of Decision Table category to return

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/1.0/decision_table_categories/{decision_table_categories_id}'

204

No body

success

Returns all Decision tables that the user has access to

Display a listing of the resource.

get

/decision_tables

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

200

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "definition": "text",
      "decision_table_categories_id": "text",
      "created_at": "2025-02-20T18:43:26.647Z",
      "updated_at": "2025-02-20T18:43:26.647Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1,
    "sort_order": "asc"
  }
}

list of Decision Tables

Save a new Decision Table

Store a newly created resource in storage.

post

/decision_tables

Authorizations

Body

idstring · id

Class Screen

namestring

descriptionstring

definitionstring

decision_table_categories_idstring

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

{
  "id": "text",
  "name": "text",
  "description": "text",
  "definition": "text",
  "decision_table_categories_id": "text",
  "created_at": "2025-02-20T18:43:26.647Z",
  "updated_at": "2025-02-20T18:43:26.647Z"
}

success

Get single Decision Table by ID

Display the specified resource.

get

/decision_tables/{decision_table_id}

Authorizations

Path parameters

decision_table_idstringrequired

ID of Decision Table to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/1.0/decision_tables/{decision_table_id}'

200

{
  "id": "text",
  "name": "text",
  "description": "text",
  "definition": "text",
  "decision_table_categories_id": "text",
  "created_at": "2025-02-20T18:43:26.647Z",
  "updated_at": "2025-02-20T18:43:26.647Z"
}

Successfully found the Decision Table

Update a Decision Table

Update a Decision table

put

/decision_tables/{decision_table_id}

Authorizations

Path parameters

decision_table_idstringrequired

ID of Decision Table to return

Body

idstring · id

Class Screen

namestring

descriptionstring

definitionstring

decision_table_categories_idstring

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

{
  "id": "text",
  "name": "text",
  "description": "text",
  "definition": "text",
  "decision_table_categories_id": "text",
  "created_at": "2025-02-20T18:43:26.647Z",
  "updated_at": "2025-02-20T18:43:26.647Z"
}

success

Delete a Decision Table

Delete a Decision tables

delete

/decision_tables/{decision_table_id}

Authorizations

Path parameters

decision_table_idstringrequired

ID of Decision Table to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/1.0/decision_tables/{decision_table_id}'

204

{
  "id": "text",
  "name": "text",
  "description": "text",
  "definition": "text",
  "decision_table_categories_id": "text",
  "created_at": "2025-02-20T18:43:26.647Z",
  "updated_at": "2025-02-20T18:43:26.647Z"
}

success

duplicate a Decision Table

duplicate a Decision table.

put

/decision_tables/{decision_table_id}/duplicate

Authorizations

Path parameters

decision_table_idstringrequired

ID of Decision Table to return

Body

idstring · id

Class Screen

namestring

descriptionstring

definitionstring

decision_table_categories_idstring

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

{
  "id": "text",
  "name": "text",
  "description": "text",
  "definition": "text",
  "decision_table_categories_id": "text",
  "created_at": "2025-02-20T18:43:26.647Z",
  "updated_at": "2025-02-20T18:43:26.647Z"
}

success

Import a new decision table

Import a Decision table from excel

post

/decision_tables/{decision_table_id}/excel-import

Authorizations

Path parameters

decision_table_idstringrequired

ID of Decision Table to return

Body

filestring · binary

file to import

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/decision_tables/{decision_table_id}/excel-import' \
  --header 'Content-Type: multipart/form-data'

201

{
  "status": {}
}

success

Export a single Decision Table by ID

Export the specified screen.

post

/decision_tables/{decision_table_id}/export

Authorizations

Path parameters

decision_table_idstringrequired

ID of Decision Table to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/decision_tables/{decision_table_id}/export'

200

{
  "url": "text"
}

Successfully exported the decision table

Import a new Decision Table

Import the specified Decision Table.

post

/decision_tables/import

Authorizations

Body

filestring · binary

file to import

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/1.0/decision_tables/import' \
  --header 'Content-Type: multipart/form-data'

201

{
  "status": {}
}

success