ProjectWise WSG icon

ProjectWise WSG

Comprehensive ProjectWise WSG API using OpenAPI architecture

Actions10

Overview

The node integrates with the ProjectWise WSG API, enabling users to interact programmatically with ProjectWise repositories. Specifically, the "Create Project" operation allows creating new projects within a specified datasource on a ProjectWise server.

This node is beneficial in scenarios where automated project creation is needed, such as:

  • Automating project setup workflows in engineering or construction environments.
  • Integrating ProjectWise project management into broader automation pipelines.
  • Creating projects dynamically based on external triggers or data sources.

For example, a user could configure this node to create a new project whenever a new client onboarding form is submitted, ensuring consistent project initialization without manual intervention.

Properties

Name Meaning
Instance JSON object representing the project instance details to be created. This is sent as the request body.
Options Collection of optional settings:
   Custom Payload Optionally override the request body with a custom JSON payload instead of the standard instance data.

Details on Properties

  • Instance: The main input defining the project to create. It should be a valid JSON object matching the expected structure for a ProjectWise project.
  • Options > Custom Payload > Use Custom Payload: Boolean flag to enable sending a fully custom JSON payload.
  • Options > Custom Payload > JSON Payload: When enabled, this JSON object replaces the default request body, allowing advanced users to craft specific API requests beyond the standard schema.

Output

The node outputs an array of items corresponding to the results of the create project operation. Each item contains a json property with the response from the ProjectWise API, typically including details about the newly created project.

If a custom payload is used, the output reflects the API's response to that payload.

No binary data output is indicated by the source code.

Dependencies

  • Requires connection to a ProjectWise WSG API endpoint.
  • Needs an API authentication token or credentials configured in n8n (e.g., API key or username/password).
  • The node uses internal helper methods to resolve datasource IDs and make OData requests.
  • No additional external libraries beyond those bundled with n8n are required.

Troubleshooting

  • Datasource Not Found: If the specified datasource name or location does not match any available datasource on the server, the node will throw an error indicating the datasource was not found. Verify the datasource name/location is correct.
  • Authentication Errors: Ensure the API credentials are valid and have sufficient permissions to create projects.
  • Invalid JSON Payload: When using the custom payload option, malformed JSON will cause errors. Validate JSON syntax before execution.
  • Missing Required Parameters: The "Instance" property must be provided unless a custom payload is used. Omitting both will result in failure.
  • API Endpoint Issues: Network connectivity or incorrect server URL configuration can cause request failures.

Links and References

Discussion