ProjectWise WSG icon

ProjectWise WSG

Comprehensive ProjectWise WSG API using OpenAPI architecture

Overview

This node integrates with the ProjectWise WSG API to perform operations on ProjectWise resources. Specifically, for the Delete Document operation under the Document resource, it deletes a document identified by its unique Document ID from a specified datasource repository.

Common scenarios where this node is beneficial include:

  • Automating cleanup of obsolete or incorrect documents in ProjectWise repositories.
  • Integrating document lifecycle management workflows where documents need to be programmatically removed.
  • Synchronizing external systems by deleting documents that no longer exist or are invalid.

Example use case: A user wants to delete a document with a known Document ID from their ProjectWise datasource as part of an automated archival or data correction process.

Properties

Name Meaning
Document ID The unique identifier of the document to delete. This is a required string input.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will confirm success or provide error details if the deletion failed.

  • The json output field contains either confirmation of successful deletion or an error object with message and context.
  • No binary data output is involved in this operation.

Dependencies

  • Requires connection to a ProjectWise WSG API server.
  • Needs credentials providing access to the ProjectWise API (an API key or token).
  • Requires configuration of the datasource name within the credentials to identify the correct repository.
  • Uses OData protocol for requests.
  • The node depends on internal helper modules for request handling and logging.

Troubleshooting

  • Common issues:

    • Incorrect or missing Document ID will cause the operation to fail.
    • Invalid or expired API credentials will prevent authentication.
    • Datasource name misconfiguration can lead to failure in resolving the repository.
    • Network connectivity issues to the ProjectWise server.
  • Error messages:

    • "Datasource \"<name>\" not found." — Check that the datasource name in credentials matches an existing repository.
    • "Failed to resolve datasource \"<name>\" to ID" — Indicates inability to map datasource name to repository ID; verify credentials and datasource name.
    • Authentication errors — Ensure API credentials are valid and have necessary permissions.
    • "Unsupported operation: <operation>" — Means the requested operation is not implemented; verify operation parameter.
  • To resolve errors, verify all input parameters, credentials, and network access. Enable detailed logging to trace request and response details.

Links and References


Note: This summary is based solely on static analysis of the provided source code and property definitions. Runtime behavior may depend on actual API responses and environment configurations.

Discussion