OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node interacts with the "Relations" resource of the OpenProject API, specifically to retrieve details about a single relation by its unique identifier. It is useful when you need to fetch information about how two entities (such as work packages or tasks) are related within an OpenProject instance.

A practical example would be automating project management workflows where you want to programmatically access and analyze dependencies or links between tasks.

Properties

Name Meaning
Id The unique numeric identifier of the relation to retrieve. This is required to specify which relation's details should be fetched.

Output

The node outputs JSON data representing the details of the requested relation. This typically includes all properties returned by the OpenProject API for a relation, such as its id, type, involved entities, and metadata.

No binary data output is expected from this operation.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • The base URL of the OpenProject instance must be configured in the node credentials.
  • The node depends on the OpenProject REST API being accessible and the specified relation ID existing.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent relation ID will result in an error response from the API.
    • Network connectivity problems or incorrect base URL configuration can cause request failures.
    • Missing or invalid API authentication credentials will prevent successful requests.
  • Error messages:

    • 404 Not Found: The specified relation ID does not exist. Verify the ID is correct.
    • 401 Unauthorized: Authentication failed. Check that the API key credential is valid and has sufficient permissions.
    • Network errors: Ensure the OpenProject server is reachable and the base URL is correctly set.

Links and References

Discussion