Calculate

Update and re-evaluate a specific calculation in a CalcTree workspace

The Calculate mutation allows you to update and re-evaluate a specific calculation in a CalcTree workspace by providing input statements. It is used to perform a calculation based on provided input values. It takes a set of input statements, processes them, and returns the updated values for each statement in the calculation.

Input Parameters

Parameter	Type	Required	Description
workspaceId	ID!	Yes	The unique ID of the CalcTree workspace
calculationId	ID!	Yes	The unique ID of the calculation
revisionId	ID!	Yes	The unique ID of the revision to calculate
statements	[StatementInput!]!	Yes	An array of input statements for the calculation

Sample Mutation

graphqlCopy codemutation Calculate($workspaceId: ID!, $calculationId: ID!, $revisionId: ID!, $statements: [StatementInput!]!) {
  calculate(workspaceId: $workspaceId, calculationId: $calculationId, revisionId: $revisionId, statements: $statements) {
    revisionId
    calculationId
    statements {
      statementId
      formula
      namedValues {
        name
        value
      }
      title
    }
  }
}

Sample Variables

jsonCopy code{
  "workspaceId": "your-workspace-id",
  "calculationId": "your-calculation-id",
  "revisionId": "your-revision-id",
  "statements": [
    {
      "statementId": "s1",
      "formula": "I = (b * h^3) / 12",
      "namedValues": [
        { "name": "b", "value": 300 },
        { "name": "h", "value": 500 }
      ]
    },
    {
      "statementId": "s2",
      "formula": "V = F / A",
      "namedValues": [
        { "name": "F", "value": 5000 },
        { "name": "A", "value": 150 }
      ]
    }
  ]
}

Sample Response

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

Description of Returned Fields

Field	Type	Description
revisionId	String	The unique ID of the new calculation revision
calculationId	String	The unique ID of the calculation
statements	Array	An array of the calculated statements
statementId	String	The unique ID of the statement
title	String	The title of the statement
formula	String	The formula used in the statement
namedValues	Array of Objects	An array of name-value pairs representing variables and their calculated values

---

Usage Example in Python

Here’s how to use the Calculate mutation in Python using the requests library:

pythonCopy codeimport requests

# Define the API endpoint and your API key
url = "https://api.calctree.com/graphql"
headers = {
          "Content-Type": "application/json",
          "x-api-key": apiKey,
        }

# Define the GraphQL mutation and variables
mutation = """
mutation Calculate($workspaceId: ID!, $calculationId: ID!, $revisionId: ID!, $statements: [StatementInput!]!) {
  calculate(workspaceId: $workspaceId, calculationId: $calculationId, revisionId: $revisionId, statements: $statements) {
    revisionId
    calculationId
    statements {
      statementId
      formula
      namedValues {
        name
        value
      }
      title
    }
  }
}
"""
variables = {
    "workspaceId": "your-workspace-id",
    "calculationId": "your-calculation-id",
    "revisionId": "your-revision-id",
    "statements": [
        {
            "statementId": "s1",
            "formula": "I = (b * h^3) / 12",
            "namedValues": [
                { "name": "b", "value": 300 },
                { "name": "h", "value": 500 }
            ]
        },
        {
            "statementId": "s2",
            "formula": "V = F / A",
            "namedValues": [
                { "name": "F", "value": 5000 },
                { "name": "A", "value": 150 }
            ]
        }
    ]
}

# Make the POST request
response = requests.post(url, json={"query": mutation, "variables": variables}, headers=headers)

# Print the response
print(response.json())

Tips for Using the Mutation

• Ensure your workspaceId, calculationId, revisionId, and statements are accurate.

• Use the calculate query to extract the statement structure and statementIDs to use as inputs in this mutation

• Unless working with a specific revision, set revisionID to "ffffffff" to access the latest version of the calculation.Comment

• Use the namedValues array to understand the inputs and outputs of each statement.

• The mutation allows you to perform multiple calculations in a single request by providing a list of statements.