Actions15
- Work Package Actions
- Project Actions
- Time Entry Actions
- Custom API Call Actions
Overview
This node allows users to make custom API calls to the OpenProject platform specifically for the Work Package resource. It supports various HTTP methods (GET, POST, PUT, PATCH, DELETE) and enables users to specify the API endpoint, request body, query parameters, and additional headers. This flexibility is useful for advanced users who need to interact with OpenProject's API beyond predefined operations, such as retrieving specific work package data, creating or updating work packages, or performing other custom actions.
Use Case Examples
- Retrieve a list of work packages with specific filters by making a GET request to /api/v3/work_packages with query parameters.
- Create a new work package by sending a POST request with a JSON body containing work package details.
- Update an existing work package by sending a PATCH request with the updated fields in the request body.
Properties
| Name | Meaning |
|---|---|
| HTTP Method | The HTTP method to use for the API call (GET, POST, PUT, PATCH, DELETE). This determines the type of operation performed on the API endpoint. |
| Endpoint | The specific API endpoint to call, e.g., /api/v3/work_packages. This defines the resource path for the API request. |
| Request Body | The JSON-formatted request body to send with POST, PUT, or PATCH requests. Contains data to create or update a work package. |
| Query Parameters | JSON-formatted query parameters to include in the API request URL. Used to filter or modify the request. |
| Additional Headers | JSON-formatted additional HTTP headers to include in the API request. Useful for custom authentication or other header needs. |
Output
JSON
json- The JSON response from the OpenProject API call, which can be a single object or an array of objects depending on the request.
Dependencies
- Requires an API key credential for OpenProject API authentication, which is used to authorize the API requests.
Troubleshooting
- Invalid JSON errors may occur if the request body, query parameters, or additional headers are not properly formatted JSON strings. Ensure valid JSON syntax.
- API authentication errors can occur if the API key credential is missing or incorrect. Verify the API key and credential configuration.
- HTTP method and endpoint must be compatible; for example, GET requests should not have a request body.
- If no fields are provided for update operations, the node throws an error indicating that at least one field must be specified.