OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node interacts with the OpenProject API to retrieve detailed information about a specific capability within the "Actions Capabilities" resource. The "View Capabilities" operation allows users to fetch metadata or details about a particular capability identified by its unique ID. This is useful in scenarios where you want to programmatically inspect permissions, actions, or features available in an OpenProject instance, for example, to dynamically adjust workflows based on user capabilities or project settings.

Properties

Name Meaning
Id The unique identifier of the capability to view. For example, "work_packages/create/p123-567". This property is required and specifies which capability's details will be retrieved.

Output

The node outputs JSON data representing the details of the requested capability. This typically includes fields describing the capability's attributes, permissions, or related metadata as defined by the OpenProject API. The exact structure depends on the API response but generally provides comprehensive information about the specified capability.

No binary data output is indicated.

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 uses the OpenProject REST API endpoint corresponding to capabilities.

Troubleshooting

  • Invalid or missing Id: If the "Id" property is incorrect or not provided, the API call will fail. Ensure the capability ID is valid and correctly formatted.
  • Authentication errors: If the API key or URL credentials are incorrect or expired, authentication will fail. Verify that the API key has sufficient permissions.
  • Network issues: Connectivity problems to the OpenProject server can cause request failures. Check network access and server availability.
  • API changes: If the OpenProject API changes, the node might return unexpected results or errors. Keep the node and API version in sync.

Links and References

Discussion