3.2 - 3.8 - REST API Designer - Report Tables

Report Table

The current methods implemented for report tables in the ProcessMaker API designer are listed below:

Report Table:

Get Report Tables List: GET project/{prj_uid}/report-tables

Gets the list of Report Tables in a project.

GET /api/1.0/{workspace}/project/{prj_uid}/report-tables

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID

Result:

Type	Description
array	Returns an array of report table objects

Example:

Response

Get Report Table: GET project/{prj_uid}/report-table/{rep_uid}

Gets a specified Report Table.

GET /api/1.0/{workspace}/project/{prj_uid}/report-table/{rep_uid}

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
rep_uid	String	Report table UID

Result:

Type	Description
object	Returns a report table object

Example:

Response

Populate Report Table: GET project/{prj_uid}/report-table/{rep_uid}/populate

Repopulates a Report Table with case data. This endpoint deletes the contents of a specified Report Table and then refills it with data from the cases. This endpoint can be called if the data in a Report Table gets out of sync with the data from the cases.

GET /api/1.0/{workspace}/project/{prj_uid}/report-table/{rep_uid}/populate

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
rep_uid	String	Report table UID

Result:

Type	Description
empty	No return

Example:

Response

Get Report Table Data: GET project/{prj_uid}/report-table/{rep_uid}/data

Gets the data from a Report Table. Returns all the rows in a Report Table and a count of the number of rows.

GET /api/1.0/{workspace}/project/{prj_uid}/report-table/{rep_uid}/data

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
rep_uid	String	Report table UID

Result:

Type	Description
object	Returns an object containing data about the report table

Example:

Response

Create Report Table: POST project/{prj_uid}/report-table

Creates a new Report Table.

Consideration:

• Must send the whole new structure of the table. If the table would have field A, B, C and the update sends A, B, D then C column is removed and D column is added.
• Must use fld_uid to update a field, if the property is not present in the field description it will be considered as a new field. Therefore, the previous field will be deleted and a new one will be created.
• Must send at least one of the two options pmt_tab_dsc or fields otherwise the server will answer with status 400.
• The table must have at least one primary key field, if not present the server will answer with status 400.
• The field structure must be completed, if any field is not provided the endpoint will answer with status 400 and a message showing the field property that is missing, for example: if the fld_type is not provided the endpoint will answer 400 "The property fld_type is not defined for field {fld_name} " or If the fld_name is not provided then the message is 400 "The property fld_name must be provided for all fields"

Permission:

Users must have the PM_FACTORY permission assigned to their role to perform this action.

Structure:

POST /api/1.0/{workspace}/project/{prj_uid}/report-table

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID

Required Fields:

Name	Type	Description
rep_tab_name	String	Report table name
rep_tab_dsc	String	Report table description
rep_tab_connection	String	Report table connection, possible values: "workflow", "rp" and database connection
rep_tab_type	String	Report table type, possible values: "NORMAL" or "GRID"
rep_tab_grid	String	Base grid UID where the report table was generated.
fields	Array	Columns in the report table. Check their variables in the following table.

Inside "fields" parameter, these are the required variables:

Name	Type	Description
fld_name	String	This variable is for the name of the field.
fld_label	String	This variable is for the label of the field.
fld_description	String	This variable is for the description of the field.
fld_type	String	This variable is for the type of the field, if it could be a "String", "Integer", etc.
fld_size	Integer	This variable is for the size of the field.

If you send an empty array you will create a Report Table with the default columns, those are the following:

Response

  ...
    "fields": [
        {
            "fld_uid": "4337807815b699dfe7235f9040768634",
            "fld_index": "0",
            "fld_name": "APP_UID",
            "fld_description": "APP_UID",
            "fld_type": "VARCHAR",
            "fld_size": "32",
            "fld_null": "0",
            "fld_auto_increment": "0",
            "fld_key": "1",
            "fld_table_index": "0"
        },
        {
            "fld_uid": "2791806115b699dfe812da4020621359",
            "fld_index": "1",
            "fld_name": "APP_NUMBER",
            "fld_description": "APP_NUMBER",
            "fld_type": "INTEGER",
            "fld_size": "11",
            "fld_null": "0",
            "fld_auto_increment": "0",
            "fld_key": "0",
            "fld_table_index": "0"
        },
        {
            "fld_uid": "2456566415b699dfe8b5820080052075",
            "fld_index": "2",
            "fld_name": "APP_STATUS",
            "fld_description": "APP_STATUS",
            "fld_type": "VARCHAR",
            "fld_size": "10",
            "fld_null": "0",
            "fld_auto_increment": "0",
            "fld_key": "0",
            "fld_table_index": "0"
        }
    ]
  ...

These columns are APP_UID, APP_NUMBER and APP_STATUS and their purpose is the following:

• APP_UID: The case's unique ID. This value is used to obteined the case information. This field can NOT be removed from the report table.
• APP_NUMBER: The case number. Report tables use this value to relate the case information with an individual case. This field can NOT be removed from the report table.
• APP_STATUS: The case status. This field can be removed from the report table if desired.

Optional Fields:

Name	Type	Description
rep_tab_class_name	String	This is the name of the generated class. It is in relationship with the rep_tab_table.

Inside "fields" parameter, these are the optional variables:

Name	Type	Description
fld_null	String	This variable define if the column accepts null values.
fld_auto_increment	String	This variable define if the column will be auto-incrementing.
fld_key	String	This variable define if the column will be the primary key.
fld_table_index	String	This variable define if the column will be an index.

Result:

Type	Description
object	Returns an object containing data about the new repot table.

Example:

Request

Response

Update Report Table: PUT project/{prj_uid}/report-table/{rep_uid}

Updates a specified Report Table.

Consideration:

• Must send the whole new structure of the table. If the table would have field A, B, C and the update sends A, B, D then C column is removed and D column is added.
• Must use fld_uid to update a field, if the property is not present in the field description it will be considered as a new field. Therefore, the previous field will be deleted and a new one will be created.

Permission:

Users must have the PM_FACTORY permission assigned to their role to perform this action.

Structure:

PUT /api/1.0/{workspace}/project/{prj_uid}/report-table/{rep_uid}

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
rep_uid	String	Report table UID

Required Fields:

Name	Type	Description
fields	Array	Columns in the report table. Check their variables in the main table.

Optional Fields:

Name	Type	Description
rep_tab_dsc	String	Report table description

Result:

Type	Description
empty	No return

Example:

Request

Response

Delete a Report Table: DELETE project/{prj_uid}/report-table/{rep_uid}

Deletes a Report Table.

Permission:

Users must have the PM_FACTORY permission assigned to their role to perform this action.

Structure:

DELETE /api/1.0/{workspace}/project/{prj_uid}/report-table/{rep_uid}

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
rep_uid	String	Report table UID

Result:

Type	Description
empty	No return

Example:

Response