OnshapeOpenApi icon

OnshapeOpenApi

undefined

Overview

This node acts as a versioned interface for the OnshapeOpenApi, supporting multiple API versions (v1, v2, and v3). It allows users to interact with the Onshape API through different versions, providing flexibility and compatibility with various Onshape API endpoints and features. Common scenarios include automating CAD data management, retrieving design information, or integrating Onshape with other systems in a workflow.

Use Case Examples

  1. Automate retrieval of CAD model metadata from Onshape.
  2. Trigger workflows based on changes in Onshape documents.
  3. Integrate Onshape design data into project management tools.

Output

JSON

  • operation - The operation performed by the node
  • resource - The resource targeted by the operation
  • data - The response data returned from the Onshape API for the requested operation

Dependencies

  • Onshape API credentials (API key or OAuth token)

Troubleshooting

  • Ensure correct API credentials are configured to avoid authentication errors.
  • Verify the selected API version matches the Onshape API features needed.
  • Check network connectivity to Onshape API endpoints.
  • Handle API rate limits and errors gracefully in workflows.

Links

Discussion