ProjectWise WSG

Comprehensive ProjectWise WSG API using OpenAPI architecture

Actions10

Document Actions
Upload Actions
- Upload Document with File
Project Actions
- Search Projects
- Create Project
Generic Actions
- Generic WSG Request
- Generic WSG Create

Overview

This node provides a generic interface to interact with the ProjectWise Web Services Gateway (WSG) API using OData queries. It allows users to perform flexible GET requests against various WSG endpoints such as Documents, Projects, Users, or any other custom endpoint by specifying the path dynamically.

Common scenarios where this node is beneficial include:

Retrieving metadata or details about documents, projects, or users stored in ProjectWise.
Performing filtered and sorted searches on ProjectWise data using OData query parameters.
Accessing hierarchical data by specifying ancestor GUIDs for scoped queries.
Executing custom or less common API calls by specifying arbitrary WSG endpoints.

Practical examples:

Fetch all documents created after a certain date, selecting only specific fields.
Retrieve project information ordered by creation date descending.
Query user data filtered by department or role.
Perform a custom request to a specialized WSG endpoint not covered by standard operations.

Properties

Name	Meaning
Endpoint	The WSG endpoint path to query (e.g., Document, Project, User).
Instance ID	Specific instance ID to retrieve from the endpoint.
Select	Fields and relationships to select in the response (OData $select syntax).
Filter	OData filter expression to limit results based on conditions (OData $filter syntax).
API Ancestor	GUID of an ancestor entity for hierarchical searches (used to scope queries).
Additional Options	Collection of optional parameters:
- Order By	Field(s) to order results by, supports ascending/descending (e.g., "Name", "CreatedDate desc").
- Include Environment Attributes	Boolean flag to include related environment attributes automatically.
- Include Full Path	Boolean flag to include absolute path information in results.

Output

The node outputs an array of JSON objects representing the results returned from the WSG API call. Each item corresponds to one record retrieved from the specified endpoint, including any selected fields and relationships.

If the API returns multiple records, they are flattened into the output array.

No binary data output is produced by this node.

Dependencies

Requires a configured API authentication credential for ProjectWise WSG API access.
Uses OData protocol conventions for querying and filtering data.
Relies on internal helper modules for making HTTP requests and handling OData parameters.
Requires network access to the specified ProjectWise WSG server URL.

Troubleshooting

Missing Endpoint Parameter: The node throws an error if the "Endpoint" property is empty because it is required to form the API request URL.
Datasource Resolution Failure: If the configured datasource name cannot be resolved to an instance ID, the node will fail with an error listing available datasources. Ensure the datasource name matches exactly or corresponds to a known location or label.
Authentication Errors: Incorrect or expired credentials will cause authorization failures. Verify that the API key or token is valid and has sufficient permissions.
Invalid OData Queries: Malformed filter or select expressions may result in API errors. Validate OData syntax before use.
Unsupported Operation: Only the "generic-wsg-request" operation is supported under the Generic resource; other operations will cause errors.
Ancestor GUID Issues: Providing an invalid or non-existent ancestor GUID may lead to empty results or errors.

To resolve errors:

Double-check all input parameters for correctness.
Confirm API credentials and server URLs.
Review API documentation for valid endpoint paths and OData query syntax.
Enable detailed logging to trace request construction and responses.