OpenProject icon

OpenProject

Interact with OpenProject via API
Join our community

Actions199

Overview

This node allows you to update an existing project in the OpenProject system via its API. It is useful for automating project management workflows where project details need to be modified programmatically, such as updating project status, description, visibility, or metadata without manual intervention.

Practical examples include:

  • Automatically archiving projects that have been inactive for a certain period.
  • Updating project descriptions or status explanations based on external triggers or data sources.
  • Changing project visibility (public/private) dynamically according to user roles or organizational policies.

Properties

Name Meaning
Id The unique identifier of the project to update (required).
Type The type of resource; fixed to "Project" for this operation.
Identifier A string identifier for the project.
Name The name of the project.
Active Boolean indicating if the project is active (true) or archived (false).
Status Explanation A JSON object containing formatted text explaining the project's current status.
Public Boolean indicating whether the project is publicly accessible.
Description A JSON object with formatted text describing the project.
Created At Timestamp string representing when the project was created.
Updated At Timestamp string representing the last time the project was updated.
Links A JSON object containing various related links and actions associated with the project resource.

Notes:

  • The Status Explanation and Description fields expect JSON input with formatting details (e.g., markdown/raw/html).
  • The Links property contains metadata about available API endpoints and actions but is typically managed internally.

Output

The node outputs the updated project data in JSON format. This output reflects the state of the project after the update operation, including all properties sent and any additional metadata returned by the API.

If the API supports binary data for projects (not indicated here), it would be summarized accordingly, but this node primarily deals with JSON data.

Dependencies

  • Requires an API key credential for authenticating with the OpenProject API.
  • Needs the base URL of the OpenProject instance configured in the credentials.
  • The node uses standard HTTP headers for JSON content negotiation (Accept: application/json, Content-Type: application/json).

Troubleshooting

  • Invalid Project ID: If the provided project ID does not exist, the API will likely return a 404 error. Verify the ID before running the node.
  • Authentication Errors: Ensure the API key and base URL are correctly set in the credentials. Authentication failures will result in 401 or 403 errors.
  • Malformed JSON Input: For fields like statusExplanation and description, ensure the JSON is well-formed and properly escaped. Parsing errors can cause the request to fail.
  • Permission Issues: Some fields like createdAt may require special admin permissions or settings enabled on the server. Lack of these permissions can cause update failures.
  • API Rate Limits: Frequent updates might hit rate limits imposed by the OpenProject API. Implement retry logic or reduce request frequency if needed.

Links and References

Discussion