Actions22
- Kanban Actions
- Meeting Actions
- Project Actions
- Team Actions
- User Actions
Overview
The node named "Workspace" integrates with a Workspace API to manage and retrieve data related to projects, teams, users, kanban boards, meetings, and more. Specifically for the Project - Reporting resource-operation, it allows users to handle project reports by fetching multiple reports, retrieving all latest reports for a specific project, creating new reports, or deleting existing ones.
This node is beneficial in scenarios where project managers or team leads want to automate report management within their workflow automation platform. For example:
- Automatically fetching paginated lists of project reports for dashboards.
- Creating detailed project progress reports programmatically after updates.
- Deleting outdated or incorrect reports as part of cleanup processes.
Properties
| Name | Meaning |
|---|---|
| Action | The operation to perform on project reports. Options: • Get Many (retrieve many reports with pagination) • Get All Latest Project Reports (fetch all reports for a specific project) • Create Project Report (create a new report for a project) • Delete Project Report (delete a specific report) |
| Report ID | The unique identifier of the report to delete (required for delete action). |
| Page | The page number to fetch when retrieving reports (used in getAll and get actions). |
| Results Per Page | Number of reports to fetch per page (used in getAll and get actions). |
| Project ID | The unique identifier of the project (required for get, delete, and create actions). |
| Create Project Report | A collection of fields required to create a new project report, including: • Project ID (string, required) • Date (dateTime, required) • Progress (number, required) • Performance Trend (string, required) • Cost Trend (string, required) • Schedule Trend (string, required) • Additional Information (string) • Schedule Hint (string) • Cost Hint (string) • Performance Hint (string) • Schedule Hint Details (string) • Cost Hint Details (string) • Performance Hint Details (string) |
Output
The node outputs JSON data representing the response from the Workspace API for the requested reporting action:
- For Get Many and Get All Latest Project Reports, the output contains paginated lists of report objects, each typically including report metadata such as IDs, dates, progress percentages, trend indicators, and descriptive hints.
- For Create Project Report, the output includes the newly created report's details confirming successful creation.
- For Delete Project Report, the output confirms deletion status, usually with minimal content.
No binary data output is indicated for this node.
Dependencies
- Requires an API key credential and tenant information to authenticate requests against the Workspace API.
- The base URL for the API and authentication headers must be configured in the node credentials.
- The node uses HTTP methods GET, POST, and DELETE to interact with the API endpoints under
/api/v2/reports.
Troubleshooting
Common Issues:
- Missing or invalid API key or tenant configuration will cause authentication failures.
- Providing incorrect or missing
projectIdorreportIdparameters may result in 404 Not Found errors. - Pagination parameters (
page,resultsPerPage) out of range might return empty results or errors. - Required fields missing in the create report action can lead to validation errors from the API.
Error Messages:
- Authentication errors: Check that API key and tenant are correctly set in credentials.
- 404 Not Found: Verify that the specified project or report IDs exist.
- Validation errors on create: Ensure all required fields (projectId, date, progress, performanceTrend, costTrend, scheduleTrend) are provided and valid.
Links and References
- Workspace API Documentation (replace with actual link if available)
- General REST API usage guides for pagination and CRUD operations.