OpenProject icon

OpenProject

Interact with OpenProject via API
Join our community

Actions199

Overview

This node interacts with the OpenProject API to list available actions capabilities. It allows users to retrieve a filtered and sorted list of actions defined in OpenProject, which can be useful for automation workflows that depend on specific project actions or permissions.

Common scenarios include:

  • Fetching a subset of actions based on certain criteria (e.g., action IDs).
  • Integrating OpenProject actions into custom workflows.
  • Auditing or displaying available actions programmatically.

For example, you might use this node to get all actions related to membership creation or filter out specific actions by their IDs.

Properties

Name Meaning
Filters JSON string specifying filter conditions to narrow down the list of actions. Supports filtering by id to return only actions matching given IDs or exclude them. The format matches the OpenProject queries endpoint filters. Example: [{"id": {"operator": "=", "values": ["memberships/create"]}}]
Sort By JSON string specifying sort criteria for the returned actions. Currently, no sorting is supported, so this property has no effect but must be provided in the expected format. Example default: [["id", "asc"]]

Output

The node outputs a JSON array containing the list of actions matching the specified filters and sort criteria. Each item in the output corresponds to an action capability object as defined by the OpenProject API.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to an OpenProject instance via its REST API.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The base URL of the OpenProject server must be set in the node's credential configuration.

Troubleshooting

  • Invalid Filter Format: If the Filters JSON is malformed or uses unsupported fields, the API may reject the request. Ensure the JSON syntax is correct and only supported filters like id are used.
  • Authentication Errors: Missing or incorrect API credentials will cause authorization failures. Verify the API key/token and base URL in the credentials.
  • Empty Results: If no actions match the filter criteria, the output will be an empty array. Adjust filters accordingly.
  • Unsupported Sorting: Although a Sort By property exists, sorting is not currently supported by the API endpoint. Providing sort criteria will have no effect.

Links and References

Discussion