Unqork documentation is available in two workspaces: UnqorkAI for the latest AI-first platform, and legacy Unqork for previous versions. Use the drop-down near the logo to switch.

Internal Services

Prev Next

Internal Services are built-in Unqork API endpoints available in the Plug-In component when Service Type is set to Unqork. They are available in every Unqork environment without additional configuration in Services Administration.

PDFs

Service

Endpoint

Method

Description

Generate PDF from HTML

/fbu/uapi/contentpdf

POST

Generates a PDF document from HTML input and saves it to cloud storage.

Generate PDF from Template

/fbu/uapi/pdfbar

POST

Fills a PDF template with supplied data. Requires a template name in the request parameters. See PDF Template Administration.

Combine PDFs

/fbu/uapi/pdfbar/combine

POST

Combines multiple PDFs into a single document. Supports optional page numbering.

Files

Service

Endpoint

Method

Description

Generate a ZIP File

/fbu/uapi/fileUtils/json2zip

POST

Creates a ZIP file from a JSON structure. Supports nested files.

Generate a CSV File

/fbu/uapi/fileUtils/json2csv

POST

Converts JSON data to a CSV file.

Convert an Image or Document

/fbu/uapi/image/convert

POST

Converts between image formats (TIFF, PNG, JPG, PDF) or converts documents (DOC, DOCX, PPT, PPTX) to PDF.

Encryption

Service

Endpoint

Method

Description

GPG Encrypt a File

/fbu/uapi/fileUtils/encrypt/gpg

Encrypts a file using a specified GPG public key. Server-side execution only.

GPG Decrypt a File

/fbu/uapi/fileUtils/decrypt/gpg

PUT

Decrypts a file using a specified GPG private key. Server-side execution only.

GPG encryption and decryption services require a corresponding GPG service configured in Services Administration before use.

Submissions

Service

Endpoint

Method

Description

List Submissions for Dashboard

/fbu/uapi/system/getSubmissions

Returns module submissions based on the end-user's role and group memberships. Supports filtering, sorting, field selection, and pagination.

Modules

Service

Endpoint

Method

Description

Get Module Components

/fbu/uapi/modules/{moduleId}/components

GET

Returns the component definitions for a module. Respects module-level permissions for the requesting end-user.

Reference Data

Service

Endpoint

Method

Description

Get Rows from Reference Data

/fbu/uapi/query/{table}/all

GET

Queries a Reference Data table with optional filtering and sorting. Returns up to 100 rows by default, or all matching rows when a filter is applied.

Get Distinct Values from Reference Data

/fbu/uapi/query/{table}/distinct

GET

Returns a distinct list of values from a single field in a Reference Data table.

Transforms

Service

Endpoint

Method

Description

Execute Transform with  Data

/fbu/uapi/transformer

POST

Executes a pre-defined transform with supplied input data.

Convert XML to JSON

/fbu/uapi/transformer/xml2json

POST

Converts XML data to JSON format.

Convert JSON to XML

/fbu/uapi/transformer/json2xml

POST

Converts JSON data to XML format.

System

Service

Endpoint

Method

Description

Increment Counter

/fbu/uapi/system/counter

POST

Increments a system counter.

Create Hash of String

/fbu/uapi/system/hash

POST

Generates a hash value from a string.


Changelog

Date

Change

—

Initial publication.