ProjectWise WSG icon

ProjectWise WSG

Comprehensive ProjectWise WSG API using OpenAPI architecture

Actions10

Overview

The node integrates with the ProjectWise WSG API, specifically enabling operations on ProjectWise documents and other resources. For the Create Document operation under the Document resource, it allows users to create new documents in a specified ProjectWise repository instance by sending JSON payloads representing the document data.

This node is beneficial when automating document management workflows within ProjectWise environments, such as programmatically adding new project documents or integrating document creation into larger automation pipelines.

Practical examples include:

  • Automatically creating project documentation from form submissions.
  • Uploading generated reports or files into ProjectWise repositories.
  • Integrating external systems that generate content needing to be stored as ProjectWise documents.

Properties

Name Meaning
Instance JSON object representing the document data to create. This is sent as the request body to the API.
Options Collection of optional settings:
  Custom Payload Allows overriding the default request body with a custom JSON payload. If enabled, this JSON is sent instead of the standard "Instance" property.

Output

The node outputs an array of JSON objects representing the response from the ProjectWise WSG API after attempting to create the document(s). The exact structure depends on the API response but typically includes details about the created document(s).

If the user enables the custom payload option, the output reflects the API's response to that custom JSON.

No binary data output is indicated for this operation.

Dependencies

  • Requires access to the ProjectWise WSG API endpoint.
  • Needs an API authentication token or credentials configured in n8n (e.g., API key or OAuth token).
  • The node expects the user to provide the correct repository instance identifier and valid JSON document data.
  • No additional external libraries beyond those bundled with n8n are required.

Troubleshooting

  • Invalid or missing instance data: Ensure the "Instance" JSON property contains all required fields for document creation according to the ProjectWise API schema.
  • Authentication errors: Verify that the API credentials are correctly set up and have permissions to create documents.
  • Datasource resolution failure: The node attempts to resolve the datasource ID from the provided instance name or identifier. If it fails, check that the datasource exists and the name matches exactly.
  • Malformed custom payload: If using the custom payload option, ensure the JSON is valid and conforms to the API requirements.
  • API endpoint errors: Confirm the API URL and endpoint paths are correct and accessible from your environment.

Common error messages will relate to invalid parameters, authorization failures, or network issues. Reviewing the detailed error message returned by the API can guide corrective actions.

Links and References

Discussion