iTwin Projects icon

iTwin Projects

Consume the iTwin Projects API

Actions5

Overview

This node interacts with the iTwin Projects API to manage project data within the iTwin platform. Specifically, the "Get" operation under the "Project" resource retrieves detailed information about a single project by its unique identifier. This is useful when you need to fetch and use project metadata in your workflows, such as displaying project details, validating project existence, or integrating project info into other systems.

Practical examples include:

  • Retrieving a project’s details before updating or deleting it.
  • Fetching project information to display in dashboards or reports.
  • Using project metadata as input for downstream automation steps.

Properties

Name Meaning
Project ID The unique identifier of the project to retrieve. This is required to specify which project’s details should be fetched.

Output

The output is a JSON object representing the retrieved project. It contains all the project properties returned by the iTwin Projects API, such as project name, number, type, status, geographic location, time zone, and data center location.

The output structure looks like this (example fields):

{
  "class": "Endeavor",
  "subClass": "Project",
  "displayName": "Example Project",
  "number": "12345",
  "type": "TypeValue",
  "status": "Active",
  "geographicLocation": "LocationValue",
  "timeZone": "TimeZoneValue",
  "dataCenterLocation": "DataCenterValue",
  "id": "project-id-string"
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API authentication token configured via OAuth2 credentials for the iTwin platform.
  • The node depends on the iTwin Projects API endpoint to fetch project data.
  • Proper network access to the iTwin API service is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Project ID will cause the API request to fail.
    • Authentication errors if the OAuth2 token is expired or not configured correctly.
    • Network connectivity problems can prevent reaching the iTwin API.

  • Error messages:

    • "Project not found": Indicates the specified Project ID does not exist or is inaccessible. Verify the ID and permissions.
    • "Unauthorized" or "Authentication failed": Check that the OAuth2 credentials are valid and have not expired.
    • "Request failed" or timeout errors: Ensure network connectivity and API availability.

To resolve these, verify the Project ID correctness, refresh or reconfigure credentials, and check network settings.

Links and References

Discussion