OpenProject icon

OpenProject

Interact with OpenProject via API

Actions199

Overview

This node allows editing an existing query in the "Queries" resource of the OpenProject system via its API. It is useful when you want to update the name or other editable properties of a saved query by specifying its unique identifier. For example, you might rename a project report query to better reflect its purpose or update it as part of an automated workflow that manages project data.

Properties

Name Meaning
Id The unique numeric identifier of the query you want to edit. This is required to specify which query to update.
Name The new name for the query. This string value updates the query's display name.

Output

The node outputs JSON data representing the updated query object returned from the OpenProject API after the edit operation. This typically includes the query's id, updated name, and possibly other metadata fields reflecting the current state of the query on the server.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • Needs the base URL of the OpenProject instance configured in the credentials.
  • Depends on the OpenProject REST API being accessible and the user having permissions to edit queries.

Troubleshooting

  • Invalid Query ID: If the provided query id does not exist, the API will likely return an error indicating the query was not found. Verify the id is correct.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Ensure the API key and URL are correctly set in the node credentials.
  • Permission Denied: The authenticated user must have rights to edit queries; otherwise, the API will reject the request.
  • Empty or Invalid Name: Providing an empty or invalid name may cause the API to reject the update. Make sure the name is a valid non-empty string.

Links and References

Discussion