Actions199
- Collections Actions
- Forms Actions
- Actions Capabilities Actions
- Activities Actions
- Attachments Actions
- Budgets Actions
- Categories Actions
- Custom Actions Actions
- Custom Options Actions
- Documents Actions
- 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
- Groups Actions
- Help Texts Actions
- Memberships Actions
- Query Filter Instance Schema Actions
- News Actions
- Notifications Actions
- O Auth 2 Actions
- Posts Actions
- Principals Actions
- Priorities Actions
- Query Columns Actions
- Query Filters Actions
- Query Operators Actions
- Query Sort Bys Actions
- Relations Actions
- Previewing Actions
- Revisions Actions
- Roles Actions
- Time Entries Actions
- Time Entry Activities Actions
- Types Actions
- User Preferences Actions
- Wiki Pages Actions
- Work Schedule Actions
- Meetings Actions
- Values Property Actions
- Projects Actions
- Queries Actions
- Users Actions
- Statuses Actions
- Versions Actions
- 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
Overview
This node interacts with the OpenProject API to retrieve help text information based on a specified help text ID. It is useful in scenarios where users need to programmatically access contextual help or documentation snippets stored within an OpenProject instance. For example, a user might automate fetching specific help texts to display in a custom dashboard or integrate them into other documentation tools.
Properties
| Name | Meaning |
|---|---|
| Id | The unique identifier of the help text to retrieve. This is a required numeric value specifying which help text entry to fetch from OpenProject. |
Output
The node outputs JSON data representing the help text corresponding to the provided ID. The structure typically includes fields such as the help text content, its ID, and possibly metadata like creation date or related resource references. No binary data output is expected.
Dependencies
- Requires an API key credential for authenticating with the OpenProject API.
- The node configuration must include the base URL of the OpenProject instance.
- The node depends on the OpenProject REST API being accessible and the user having appropriate permissions to read help texts.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Providing an invalid or non-existent help text ID will result in errors or empty responses.
- Network connectivity problems to the OpenProject server can cause request timeouts or failures.
Error messages and resolutions:
- Authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
- Not found errors: Confirm that the help text ID exists in the OpenProject system.
- Timeouts or connection errors: Check network connectivity and the OpenProject server status.
Links and References
- OpenProject API Documentation
- n8n Documentation on HTTP Request Nodes (for understanding API interaction basics)