Check authentication and session against the configured Fluig server.

List datasets on the server (id + type). Optional substring filter over id and description.

Return the source code of a CUSTOM dataset.

Run a dataset (form-backed or custom) and return its rows.

Return a dataset's structure (columns and types) WITHOUT running it — useful to learn the schema before composing a query.

Create or update a CUSTOM dataset. The code runs on the server under Rhino, so it must be ES5 (no let/const, arrow functions or template literals).

DESTRUCTIVE. Delete a CUSTOM dataset from the server. Also how this server cleans up its own throwaway datasets.

List forms (documentId, version, description, dataset). Optional substring filter.

Return a form's customisation events (displayFields, validateForm, enableFields, ...) with their source.

List the file names (HTML/JS/CSS/images) that make up a form.

Return the text content of one file of a form.

Read a whole form: metadata, every file and every event. Do this before editing or publishing.

Publish a form as a new (revertible) version. The API REPLACES the whole set, so send ALL files and events — read it with fluig_form_full first and change only what you need.

List the server's global events.

Create or update a global event.

Run a SELECT against the Fluig database through a throwaway dataset. Read-only (SELECT/WITH only). Reaches any table, including event_proces, DEF_PROCES and the FDN_* metadata.

Run a SELECT directly against the TOTVS RM database, when Fluig has a datasource for it. Read-only (SELECT/WITH only).

Query TOTVS RM through the stored-SQL bridge dataset: a registered statement code plus branch (CODCOLIGADA) and application (CODAPLICACAO). Read-only. The columns the statement returns must be declared.

WRITE. Run INSERT/UPDATE/DELETE against the TOTVS RM database. Note that the RM datasource is often configured read-only, in which case the supported write path is the RM DataServer API instead.

Download a process definition as .ecm30.xml. It contains everything: activities (ProcessState), transitions (ProcessLink), fields and the source of every process event.

Read process events (beforeStateEntry, afterTaskCreate, afterProcessFinish, ...) with their source, straight from the definition XML. This is the authoritative copy — no add-on widget and no database access needed.

List the versions of a process (number, bound form, whether it is still in edition). Use before withdrawing or deleting a version.

Active version of a process (SOAP).

Return the documentId of the form bound to a process.

Return the flow diagram of a process (URL or base64, depending on the server).

Search processes by text. Set favorite=true to return only the user's favourites.

List the processes the logged-in user is allowed to start.

List the processes available for export/deploy (SOAP WorkflowEngineService). Useful to validate a deploy with a round trip.

Read the source of a process event from the event_proces table. Legacy path — prefer fluig_process_events_xml, which reads the authoritative definition.

WRITE. Set the source of a process event through the supported path: export the definition XML, patch the event, re-import. Produces a NEW, revertible version and passes server-side validation. Try dryRun=true first.

WRITE, STRUCTURAL. Deploy a process definition (.ecm30.xml) over the v2 REST API. One call replaces the SOAP sequence createWorkFlowProcessVersion -> importProcess -> releaseProcess. Validate with a round trip (export, then import unchanged) before trusting it.

WRITE, STRUCTURAL. Deploy a process definition over SOAP WorkflowEngineService (importProcess + releaseProcess). Alternative to fluig_process_import_xml for servers that do not expose the v2 REST route.

WRITE. Withdraw a process version — the inverse of release, and how a bad deploy is rolled back. Also mandatory before deleting a released version.

DESTRUCTIVE. Delete a process version (withdraw it first if released). Deleting the LAST version removes the entire process definition.

WRITE. Replace the SVG diagram of a process version. Required after changing the topology in the XML, otherwise the published drawing no longer matches the flow.

DEPRECATED, WRITE. Patch a process event in place in the event_proces table, keeping a backup of the previous source. Bypasses server-side validation and does not create a new version — prefer fluig_process_event_set_xml.

List the valid target states (choosedState) from an instance's current state.

Target states with name and type from the current state — richer than fluig_process_states.

List the states an instance currently sits on.

Return the current thread of a given state sequence of an instance.

Read the WHOLE card of a running instance as {field: value}. Do this before fluig_process_move, because moving REPLACES the card.

Read a single card field of a running instance.

Full movement history of an instance: who moved it, when, from and to which activity, with comments.

List the attachments of an instance.

Users eligible to receive the task at a given state of a running instance.

Users eligible to receive the first task when starting a process.

List configured user replacements — who answers for whom, and for how long. Explains why a task landed on someone else.

WRITE. Start a process instance. cardData holds the form fields; choosedState is the target state when the start activity completes. The configured user needs the start role.

WRITE. Save and move an existing instance. cardData REPLACES the card — send every field that must survive or it is wiped. Call fluig_process_take first if the task belongs to a pool.

WRITE. Take ownership of a task — required for pool/role tasks before moving them.

WRITE. Cancel/close a running instance.

Check whether the optional FluiggersWidget add-on is installed. Not required: the fluig_process_*_xml tools cover process events on a stock server.

Read a process's events through the FluiggersWidget add-on. Requires the widget; fluig_process_events_xml does not.

WRITE. Set a process's events through the FluiggersWidget add-on. Requires the widget; fluig_process_event_set_xml does not and is versioned.

Escape hatch: authenticated GET against any path of the Fluig API.

Escape hatch: authenticated POST against any path. body is a JSON string; set form=true for x-www-form-urlencoded.