processmaker.com Knowledge Center ProcessMaker University

Decision Engine

PreviousCollections NextSaved Search

Last updated 5 months ago

Get single Decision Table category by ID

get

Display the specified decision Tables category.

Authorizations

Path parameters

decision_table_categories_idstringRequired

ID of Decision Table category to return

Responses

200

Successfully found the Decision Table

application/json

Responseall of

and

get

GET /api/1.0/decision_table_categories/{decision_table_categories_id} HTTP/1.1
Host: 
Accept: */*

200

Successfully found the Decision Table

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-05-23T17:17:31.198Z",
  "updated_at": "2025-05-23T17:17:31.198Z"
}

Delete a Decision Table category

delete

Remove the specified resource from storage.

Authorizations

Path parameters

decision_table_categories_idstringRequired

ID of Decision Table category to return

Responses

204

success

delete

DELETE /api/1.0/decision_table_categories/{decision_table_categories_id} HTTP/1.1
Host: 
Accept: */*

204

success

No content

Returns all Decision tables that the user has access to

get

Display a listing of the resource.

Authorizations

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 · enumOptionalDefault: ascPossible values:

per_pageintegerOptionalDefault: 10

includestringOptional

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

Default: ""

Responses

200

list of Decision Tables

application/json

get

GET /api/1.0/decision_tables HTTP/1.1
Host: 
Accept: */*

200

list of Decision Tables

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "definition": "text",
      "decision_table_categories_id": "text",
      "created_at": "2025-05-23T17:17:31.198Z",
      "updated_at": "2025-05-23T17:17:31.198Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Get single Decision Table by ID

get

Display the specified resource.

Authorizations

Path parameters

decision_table_idstringRequired

ID of Decision Table to return

Responses

200

Successfully found the Decision Table

application/json

Responseall of

and

get

GET /api/1.0/decision_tables/{decision_table_id} HTTP/1.1
Host: 
Accept: */*

200

Successfully found the Decision Table

{
  "id": "text",
  "name": "text",
  "description": "text",
  "definition": "text",
  "decision_table_categories_id": "text",
  "created_at": "2025-05-23T17:17:31.198Z",
  "updated_at": "2025-05-23T17:17:31.198Z"
}

Delete a Decision Table

delete

Delete a Decision tables

Authorizations

Path parameters

decision_table_idstringRequired

ID of Decision Table to return

Responses

204

success

application/json

Responseall of

and

delete

DELETE /api/1.0/decision_tables/{decision_table_id} HTTP/1.1
Host: 
Accept: */*

204

success

{
  "id": "text",
  "name": "text",
  "description": "text",
  "definition": "text",
  "decision_table_categories_id": "text",
  "created_at": "2025-05-23T17:17:31.198Z",
  "updated_at": "2025-05-23T17:17:31.198Z"
}

Export a single Decision Table by ID

post

Export the specified screen.

Authorizations

Path parameters

decision_table_idstringRequired

ID of Decision Table to return

Responses

200

Successfully exported the decision table

application/json

post

POST /api/1.0/decision_tables/{decision_table_id}/export HTTP/1.1
Host: 
Accept: */*

200

Successfully exported the decision table

{
  "url": "text"
}

Returns all Decision Tables categories that the user has access to

get

Display a listing of the Decision Tables Categories.

Authorizations

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 · enumOptionalDefault: ascPossible values:

per_pageintegerOptionalDefault: 10

Responses

200

list of Decision Tables categories

application/json

get

GET /api/1.0/decision_table_categories HTTP/1.1
Host: 
Accept: */*

200

list of Decision Tables categories

{
  "data": [
    {
      "name": "text",
      "status": "ACTIVE",
      "id": "text",
      "created_at": "2025-05-23T17:17:31.198Z",
      "updated_at": "2025-05-23T17:17:31.198Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Save a new Decision Table Category

post

Store a newly created Decision Tables Category in storage

Authorizations

Body

namestringOptional

Represents a business decision Table category definition.

statusstring · enumOptionalPossible values:

Responses

201

success

application/json

Responseall of

and

post

POST /api/1.0/decision_table_categories HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "name": "text",
  "status": "ACTIVE"
}

201

success

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-05-23T17:17:31.198Z",
  "updated_at": "2025-05-23T17:17:31.198Z"
}

Update a Decision Table Category

put

Updates the current element

Authorizations

Path parameters

decision_table_categories_idstringRequired

ID of Decision Table category to return

Body

namestringOptional

Represents a business decision Table category definition.

statusstring · enumOptionalPossible values:

Responses

200

success

application/json

Responseall of

and

put

PUT /api/1.0/decision_table_categories/{decision_table_categories_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "name": "text",
  "status": "ACTIVE"
}

200

success

{
  "name": "text",
  "status": "ACTIVE",
  "id": "text",
  "created_at": "2025-05-23T17:17:31.198Z",
  "updated_at": "2025-05-23T17:17:31.198Z"
}

Save a new Decision Table

post

Store a newly created resource in storage.

Authorizations

Body

idstring · idOptional

Class Screen

namestringOptional

descriptionstringOptional

definitionstringOptional

decision_table_categories_idstringOptional

Responses

201

success

application/json

Responseall of

and

post

POST /api/1.0/decision_tables HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "id": "text",
  "name": "text",
  "description": "text",
  "definition": "text",
  "decision_table_categories_id": "text"
}

201

success

{
  "id": "text",
  "name": "text",
  "description": "text",
  "definition": "text",
  "decision_table_categories_id": "text",
  "created_at": "2025-05-23T17:17:31.198Z",
  "updated_at": "2025-05-23T17:17:31.198Z"
}

Update a Decision Table

put

Update a Decision table

Authorizations

Path parameters

decision_table_idstringRequired

ID of Decision Table to return

Body

idstring · idOptional

Class Screen

namestringOptional

descriptionstringOptional

definitionstringOptional

decision_table_categories_idstringOptional

Responses

204

success

application/json

Responseall of

and

put

PUT /api/1.0/decision_tables/{decision_table_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "id": "text",
  "name": "text",
  "description": "text",
  "definition": "text",
  "decision_table_categories_id": "text"
}

204

success

{
  "id": "text",
  "name": "text",
  "description": "text",
  "definition": "text",
  "decision_table_categories_id": "text",
  "created_at": "2025-05-23T17:17:31.198Z",
  "updated_at": "2025-05-23T17:17:31.198Z"
}

duplicate a Decision Table

put

duplicate a Decision table.

Authorizations

Path parameters

decision_table_idstringRequired

ID of Decision Table to return

Body

idstring · idOptional

Class Screen

namestringOptional

descriptionstringOptional

definitionstringOptional

decision_table_categories_idstringOptional

Responses

201

success

application/json

Responseall of

and

put

PUT /api/1.0/decision_tables/{decision_table_id}/duplicate HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "id": "text",
  "name": "text",
  "description": "text",
  "definition": "text",
  "decision_table_categories_id": "text"
}

201

success

{
  "id": "text",
  "name": "text",
  "description": "text",
  "definition": "text",
  "decision_table_categories_id": "text",
  "created_at": "2025-05-23T17:17:31.198Z",
  "updated_at": "2025-05-23T17:17:31.198Z"
}

Import a new decision table

post

Import a Decision table from excel

Authorizations

Path parameters

decision_table_idstringRequired

ID of Decision Table to return

Body

filestring · binaryOptional

file to import

Responses

201

success

application/json

post

POST /api/1.0/decision_tables/{decision_table_id}/excel-import HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

201

success

{
  "status": {}
}

Import a new Decision Table

post

Import the specified Decision Table.

Authorizations

Body

filestring · binaryOptional

file to import

Responses

201

success

application/json

post

POST /api/1.0/decision_tables/import HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

201

success

{
  "status": {}
}