OpenProject

Interact with OpenProject via API

Actions199

Collections Actions
- View Aggregated Result
Forms Actions
- Show Or Validate Form
Actions Capabilities Actions
- List Actions
- View Action
- List Capabilities
- View Capabilities
Activities Actions
- View Activity
- Update Activity
Attachments Actions
- Delete Attachment
- View Attachment
- List Attachments By Meeting
- Add Attachment To Meeting
- List Attachments By Post
- Add Attachment To Post
- List Attachments By Wiki Page
- Add Attachment To Wiki Page
- List Work Package Attachments
- Create Work Package Attachment
Budgets Actions
- View Budget
- View Budgets Of A Project
Categories Actions
- View Category
- List Categories Of A Project
Custom Actions Actions
- Get Custom Action
- Execute Custom Action
Custom Options Actions
- View Custom Option
Documents Actions
- List Documents
- View Document
File Links Actions
- View File Link
- Delete File Link
- Open File Link
- Download File Link
- List Project Storages
- Get Project Storage
- Open Project Storage
- Create Storage
- Get Storage
- Update Storage
- Delete Storage
- Get Storage Files
- Prepare Storage File Upload
- Create Storage Folder
- Create Storage Oauth Credentials
- Open Storage
- Create Work Package File Link
- List Work Package File Links
Grids Actions
- List Grids
- Create Grid
- Get Grid
- Update Grid
- Grid Update Form
Groups Actions
- List Groups
- Create Group
- Delete Group
- Get Group
- Update Group
Help Texts Actions
- Get Help Text
Memberships Actions
- List Memberships
- Create Membership
- Form Create Membership
- Delete Membership
- Get Membership
- Update Membership
- Form Update Membership
Query Filter Instance Schema Actions
- List Query Filter Instance Schemas For Project
- View Query Filter Instance Schema
News Actions
- List News
- Create News
- View News
- Update News
- Delete News
Notifications Actions
- List Notifications
- Read Notifications
- Unread Notifications
- View Notification
- View Notification Detail
- Read Notification
- Unread Notification
O Auth 2 Actions
- Get Oauth Application
- Get Oauth Client Credentials
Posts Actions
- View Post
Principals Actions
- List Placeholder Users
- Create Placeholder User
- Delete Placeholder User
- View Placeholder User
- Update Placeholder User
- List Principals
- List Users
- Create User
- Delete User
- View User
- Update User
Priorities Actions
- View Priority
Query Columns Actions
- View Query Column
Query Filters Actions
- View Query Filter
Query Operators Actions
- View Query Operator
Query Sort Bys Actions
- View Query Sort By
Relations Actions
- List Relations
- Get Relation
- Delete Relation
- Update Relation
- Create Relation
Previewing Actions
- Preview Markdown Document
Revisions Actions
- View Revision
Roles Actions
- List Roles
- View Role
Time Entries Actions
- List Time Entries
- Create Time Entry
- Time Entry Update Form
- Delete Time Entry
- Get Time Entry
- Update Time Entry
Time Entry Activities Actions
- Get Time Entries Activity
Types Actions
- List Types Available In A Project
- View Type
User Preferences Actions
- Update User Preferences
Wiki Pages Actions
- View Wiki Page
Work Schedule Actions
- List Non Working Days
- Create Non Working Day
- View Non Working Day
- Update Non Working Day
- Delete Non Working Day
- Update Week Days
- View Week Day
- Update Week Day
- List Days
- View Day
Meetings Actions
- View Meeting
Values Property Actions
- View Notification Detail
- View Values Schema
Projects Actions
- List Projects
- Create Project
- Delete Project
- View Project
- Update Project
- Project Update Form
- Create Project Copy
- Project Copy Form
- View Project Status
- List Available Parent Project Candidates
- List Projects With Version
Queries Actions
- View Default Query For Project
- View Schema For Project Queries
- List Queries
- Create Query
- View Default Query
- Query Create Form
- Delete Query
- View Query
- Edit Query
- Query Update Form
- Star Query
- Unstar Query
Users Actions
- Update User
- List Users
- Create User
- Delete User
- View User
- User Update Form
- Unlock User
- Lock User
Statuses Actions
- Get Status
Versions Actions
- List Versions Available In A Project
- List Versions
- Delete Version
- View Version
- Update Version
- Version Update Form
Work Packages Actions
- Get Project Work Package Collection
- Create Project Work Package
- List Work Package File Links
- Form Create Work Package In Project
- Project Available Assignees
- List Work Packages
- Create Work Package
- Form Create Work Package
- List Work Package Schemas
- View Work Package Schema
- Delete Work Package
- View Work Package
- Update Work Package
- List Work Package Activities
- Comment Work Package
- Work Package Available Assignees
- Available Projects For Work Package
- List Available Relation Candidates
- Available Watchers
- Create Work Package File Link
- Form Edit Work Package
- Revisions
- Reminders
- List Watchers
- Add Watcher
- Remove Watcher
Views Actions
- List Views
- View View
- Create Views
- Get Custom Field Items
- Get Custom Field Item
- Get Custom Field Item Branch

Overview

The "Update News" operation in this node allows users to update an existing news item by specifying its unique identifier and providing new values for various fields such as the title, summary, description, and related links. This operation is useful in scenarios where news content needs to be edited or corrected after initial publication, ensuring that the latest information is always available.

Practical examples include:

Updating a news headline to correct a typo.
Adding more detailed information to the news body.
Modifying associated project links related to the news item.

Properties

Name	Meaning
Id	The unique numeric identifier of the news item to update.
Title	The headline of the news; a string representing the main title.
Summary	A short summary providing a brief overview of the news content.
Description	The main body of the news with all details, formatted as JSON supporting markdown/html.
Links	JSON object containing related links, e.g., to projects or other resources.

Output

The output of this operation will be a JSON object representing the updated news item as returned by the API. It typically includes the updated fields such as id, title, summary, description, and any linked resources.

If the node supports binary data output (not indicated here), it would represent attachments or media related to the news item, but based on the provided code and properties, the output is purely JSON.

Dependencies

Requires an API key credential for authenticating requests to the OpenProject API.
The base URL for the API must be configured in the node credentials.
The node uses the OpenProject REST API to perform the update operation.

Troubleshooting

Common issues:
- Providing an invalid or non-existent news Id will result in an error indicating the resource was not found.
- Malformed JSON in the Description or Links fields can cause parsing errors.
- Missing required fields like Id will prevent the request from being sent.
Error messages:
- "Resource not found" — Check that the Id corresponds to an existing news item.
- "Invalid JSON format" — Ensure that JSON inputs for Description and Links are correctly formatted.
- "Authentication failed" — Verify that the API key credential is valid and has sufficient permissions.

Links and References

OpenProject API Documentation
Markdown Guide (for formatting the Description field)

OpenProjectInstall