Queries

Extract information about your calculations via GraphQL queries

Get Calculation 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.

Variables

Parameter	Type	Required	Description
workspaceId	ID!	Yes	The unique ID of the CalcTree workspace
calculationId (pageID)	ID!	Yes	The unique ID of the calculation
revisionId	ID!	Yes	The unique ID of the revision to retrieve

Sample Query

query GetCalculation($workspaceId: ID!, $calculationId: ID!, $revisionId: ID!) {
  calculation(workspaceId: $workspaceId, calculationId: $calculationId, revisionId: $revisionId) {
    calculationId
    statements {
      statementId
      title
      engine
      formula
      namedValues {
        name
        value
      }
    }
  }
}

Sample Variables

{
  "workspaceId": "your-workspace-id",
  "calculationId": "your-calculation-id",
  "revisionId": "your-revision-id"
}

Sample Response

CHECK

{
  "data": {
    "calculation": {
      "calculationId": "12345",
      "statements": [
        {
          "statementId": "s1",
          "title": "Moment of Inertia Calculation",
          "engine": "python",
          "formula": "I = (b * h^3) / 12",
          "namedValues": [
            {
              "name": "b",
              "value": 300
            },
            {
              "name": "h",
              "value": 500
            }
          ]
        },
        {
          "statementId": "s2",
          "title": "Shear Force Calculation",
          "engine": "python",
          "formula": "V = F / A",
          "namedValues": [
            {
              "name": "F",
              "value": 5000
            },
            {
              "name": "A",
              "value": 150
            }
          ]
        }
      ]
    }
  }
}

Use queries to collect information about a calculations structure, statementIDs and so on.