OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node operation, List Capabilities under the Actions Capabilities resource, retrieves a list of capabilities from OpenProject based on specified filter and sorting criteria. It is useful for scenarios where you want to query what actions or permissions are available for certain principals (users or groups), contexts (such as projects or global scope), or specific actions within OpenProject.

Practical examples include:

  • Fetching all capabilities assigned to a particular user or group.
  • Listing capabilities available within a specific project context.
  • Retrieving capabilities related to a specific action to understand permission scopes.

Properties

Name Meaning
Filters JSON string specifying filter conditions to narrow down the capabilities returned. It accepts the same format as OpenProject's queries endpoint. Examples:
- Filter by action to get all capabilities of that action.
- Filter by principal to get all capabilities of a user/group.
- Filter by context to get capabilities within a project (p{id}) or global (g) context.
Sort By JSON string specifying sort criteria for the results. Accepts the same format as OpenProject's queries endpoint. Currently supports sorting by id in ascending or descending order. Default is ascending by id.

Output

The node outputs JSON data representing the list of capabilities matching the provided filters and sorted according to the specified criteria. Each capability item typically includes details such as its ID, associated action, principal, and context.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • The node depends on the OpenProject REST API being accessible at the URL configured in the credentials.
  • No additional external dependencies beyond the OpenProject API and n8n's HTTP request capabilities.

Troubleshooting

  • Invalid JSON in Filters or Sort By: Since both properties expect JSON strings, malformed JSON will cause errors. Ensure the JSON syntax is correct before running the node.
  • Authentication Errors: If the API key or base URL is incorrect or missing, the node will fail to connect. Verify credentials and endpoint URL.
  • Empty Results: If filters are too restrictive or incorrectly formatted, no capabilities may be returned. Try broadening filters or removing them to test connectivity.
  • Unsupported Sort Fields: Sorting by fields other than id is not supported and may cause errors or ignored parameters.

Links and References

Discussion