Queries

Extract information about your calculations via GraphQL queries

GetCalculation Query

The GetCalculation query retrieves detailed information about a specific calculation in a CalcTree workspace, including its statements, formulas, and values.

Purpose

This query allows you to fetch the details of a calculation by specifying:

• The workspace where the calculation is stored

• The calculation itself

• A specific revision of the calculation

It returns the calculation’s ID along with all statements and their associated properties.

See detailed documentation for this query here.

Calculate Query

The calculate query re-evaluates a specific calculation in a CalcTree workspace using provided statements. This is used to dynamically update formulas and retrieve recalculated values based on new inputs.

Purpose

This query allows you to:

• Provide a set of updated or new formulas.

• Re-evaluate the specified calculation using those formulas.

• Receive updated outputs for each statement.

It requires:

• The ID of the workspace.

• The ID of the calculation.

• A specific revision (or a placeholder revision such as "ffffffff" to fetch the latest).

• StatementIDs which can be colelcted from the GetCalculation query.

The response includes the calculation ID, the revision used, and a list of all evaluated statements with their calculated values.

See detailed documentation for this query here.