Overview

This node, named OnshapeComment, is designed to interact with Onshape comments across different API versions (v1, v2, and v3). It supports multiple versions of the Onshape API, allowing users to manage comments within the Onshape platform. Typical use cases include creating, retrieving, updating, or deleting comments on Onshape documents or parts, facilitating collaboration and communication within engineering or design workflows.

Use Case Examples

1. Creating a new comment on an Onshape document to provide feedback.
2. Retrieving all comments associated with a specific Onshape part for review.
3. Updating an existing comment to clarify design instructions.
4. Deleting a comment that is no longer relevant to the project.

Output

JSON

• commentId - Unique identifier of the comment
• documentId - Identifier of the Onshape document associated with the comment
• partId - Identifier of the part within the document related to the comment
• author - Information about the author of the comment
• content - Text content of the comment
• createdAt - Timestamp when the comment was created
• updatedAt - Timestamp when the comment was last updated

Dependencies

• Onshape API credentials for authentication

Troubleshooting

• Ensure that the Onshape API credentials are correctly configured and have the necessary permissions to access comments.
• Verify that the document and part IDs provided are valid and exist in the Onshape account.
• Check for API version compatibility issues if using older versions of the node.
• Common error messages may include authentication failures, invalid resource identifiers, or permission denied errors. Resolving these typically involves verifying credentials, input parameters, and user permissions.

Links

• Onshape API Documentation - Official documentation for Onshape APIs including comments management.