OnshapeDocument icon

OnshapeDocument

undefined

Overview

This node, named OnshapeDocument, is designed to interact with Onshape documents across multiple API versions (v1, v2, and v3). It supports different versions of the Onshape API to perform operations related to Onshape documents, making it useful for workflows that require integration with Onshape CAD documents, such as retrieving, updating, or managing document data.

Use Case Examples

  1. Automate retrieval of Onshape document metadata for reporting.
  2. Update Onshape document properties as part of a product lifecycle management workflow.
  3. Integrate Onshape document data with other engineering or manufacturing systems.

Output

JSON

  • operation - The operation performed on the Onshape document
  • resource - The resource type, here it is OnshapeDocument
  • data - The resulting data from the Onshape document operation, structure depends on the API version and operation

Dependencies

  • Requires API authentication credentials for Onshape to access document data.

Troubleshooting

  • Ensure correct API credentials are configured to avoid authentication errors.
  • Verify the selected API version matches the Onshape API version in use to prevent compatibility issues.
  • Check network connectivity to Onshape services to avoid request failures.

Links

Discussion