ProjectWise WSG icon

ProjectWise WSG

Comprehensive ProjectWise WSG API using OpenAPI architecture

Actions10

Overview

This node provides a generic interface to create resources via the ProjectWise Web Services Gateway (WSG) API. It allows users to send custom JSON payloads to any specified WSG endpoint path, enabling flexible creation of various entities within the ProjectWise environment.

Common scenarios include:

  • Creating new documents, projects, or other repository items in ProjectWise by specifying the appropriate WSG endpoint.
  • Sending custom structured data to specialized or less common endpoints not covered by predefined operations.
  • Integrating ProjectWise resource creation into automated workflows where dynamic payloads are required.

Practical example:

  • A user wants to create a new project folder in ProjectWise by sending a JSON payload to the /Projects endpoint.
  • Another use case is uploading metadata for a document by posting to a specific WSG endpoint with a tailored JSON body.

Properties

Name Meaning
Endpoint The WSG endpoint path where the create request will be sent. Example: Projects, Documents.
Instance JSON object representing the instance data to be sent as the request body.
Options Additional options for the request:
  Custom Payload Allows overriding the default request body with a fully custom JSON payload. If enabled, this JSON is sent instead of the standard instance data.

Output

The node outputs an array of JSON objects representing the response from the WSG API after the create operation. Each item corresponds to the result of a single create request and contains the properties returned by the API.

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

No binary data output is indicated or handled by this node.

Dependencies

  • Requires valid credentials for the ProjectWise WSG API, including the server URL and authentication tokens.
  • The node depends on the ProjectWise WSG API being accessible and properly configured.
  • No additional external services beyond the ProjectWise WSG API are required.

Troubleshooting

  • Missing or incorrect endpoint: If the "Endpoint" property is empty or invalid, the node will throw an error indicating that the endpoint parameter is required.
  • Authentication failures: Ensure that the provided API credentials are correct and have sufficient permissions to perform create operations.
  • Invalid JSON payload: When using the custom payload option, ensure the JSON is well-formed and matches the expected schema of the target WSG endpoint.
  • Datasource resolution errors: The node attempts to resolve the datasource ID based on the provided instance information. If it cannot find the datasource, it will report available datasources to help diagnose configuration issues.
  • API errors: Any errors returned by the WSG API during the create operation will be surfaced in the node output or cause execution failure unless "Continue On Fail" is enabled.

Links and References

Discussion