Actions22
- Kanban Actions
- Meeting Actions
- Project Actions
- Team Actions
- User Actions
Overview
The "Project - General" operation node allows users to manage projects within a workspace via an API. It supports creating new projects, deleting existing ones, retrieving multiple projects with pagination, and updating project details. This node is useful for automating project lifecycle management tasks such as adding new projects, cleaning up old projects, fetching project lists for reporting or dashboards, and modifying project information programmatically.
Practical examples include:
- Automatically creating a new project when a sales deal is closed.
- Periodically fetching all projects to sync with another system.
- Updating project status or priority based on external triggers.
- Deleting obsolete projects after completion or cancellation.
Properties
| Name | Meaning |
|---|---|
| Action | The operation to perform on the project resource. Options: Create Project, Delete Project, Get Many (retrieve multiple projects), Update Project. |
| Project ID | Unique identifier of the project. Required for Delete and Get (single) actions. |
| Page | Page number for paginated retrieval of projects. Used with Get Many action. |
| Results Per Page | Number of projects to fetch per page in paginated requests. Used with Get Many action. |
Create Project Fields (used when Action = Create Project)
| Name | Meaning |
|---|---|
| Name | Name of the project (max 64 characters). Required. |
| Number | Alphanumeric project identifier, can contain hyphens. Required. |
| Description | Detailed description of the project. Required. |
| Planned Start | Planned start date in ISO 8601 format. Required. |
| Planned End | Planned end date in ISO 8601 format. Required. |
| Initiative Owner ID | Unique identifier of the initiative owner. |
| Initiative Owner Mail | Email address of the initiative owner. |
| Project Manager ID | Unique identifier of the project manager. |
| Project Manager Mail | Email address of the project manager. |
| Priority | Numeric priority level of the project. |
| Urgency | Numeric urgency level of the project. |
| Importance | Numeric importance level of the project. |
| Benefit | Numeric benefit level of the project. |
| Project Status | Current status or pipeline stage of the project. |
| Customer | Customer associated with the project. |
| Project Benefit | Text describing the benefits of the project. |
| Project Motivation | Text describing the motivation behind the project. |
| Project Situation | Text describing the current situation of the project. |
| Additional Information | Any additional information about the project. |
| Project Main Goals | Description of the main goals of the project. |
| Project Main Risks | Description of the main risks related to the project. |
| Project Specifications | Specifications such as interfaces or relations relevant to the project. |
| Project Template ID | Identifier of a template project to base this project on. |
| Project Template Number | Project number of the template project. |
| Copy Template Containers | Boolean flag to copy containers from the template project. |
| Copy Template Kanban | Boolean flag to copy kanban items from the template project. |
| Urgency Description | Text description explaining the urgency rating. |
| Importance Description | Text description explaining the importance rating. |
| Benefit Description | Text description explaining the benefit rating. |
| Budget | Numeric budget allocated for the project. |
Update Project Fields (used when Action = Update Project)
| Name | Meaning |
|---|---|
| Project ID | Unique identifier of the project to update. Required. |
| Project Name | New name for the project (max 64 characters). |
| Project Number | New alphanumeric project identifier, can contain hyphens. |
| Project Description | New detailed description of the project. |
| Project Start Date | New planned start date in ISO 8601 format. |
| Project End Date | New planned end date in ISO 8601 format. |
| Initiative Owner ID | New unique identifier of the initiative owner. |
| Project Manager ID | New unique identifier of the project manager. |
| Priority | New numeric priority level. |
| Priority Description | Text description explaining the priority rating. |
| Urgency | New numeric urgency level. |
| Urgency Description | Text description explaining the urgency rating. |
| Importance | New numeric importance level. |
| Importance Description | Text description explaining the importance rating. |
| Benefit | New numeric benefit level. |
| Benefit Description | Text description explaining the benefit rating. |
| Client | Name of the client. |
| Project Benefit | Description of the project's benefits. |
| Motivation | Description of the project's motivation. |
| Initial Situation | Description of the initial situation of the project. |
| Additional Information | Additional information about the project. |
| Project Targets | Description of the project targets. |
| Budget | Numeric budget for the project. |
Output
The node outputs JSON data representing the response from the Workspace API corresponding to the performed action:
- For Create Project, the output contains the newly created project's details.
- For Delete Project, the output confirms deletion success or failure.
- For Get Many, the output includes a paginated list of projects with their attributes.
- For Update Project, the output contains the updated project details.
The exact structure depends on the API response but generally includes project identifiers, names, descriptions, dates, statuses, and other metadata fields.
No binary data output is involved.
Dependencies
- Requires connection to the Workspace API endpoint.
- Needs an API key credential and tenant identifier configured in n8n credentials.
- The base URL for the API must be set in the node's credential configuration.
- The API expects JSON content type and uses specific headers for authentication.
Troubleshooting
- Missing or invalid API credentials: Ensure that the API key and tenant values are correctly set in the node credentials.
- Invalid project IDs: When deleting or updating, verify that the provided project ID exists and is correctly formatted.
- Pagination parameters: For "Get Many", ensure
pageandresultsPerPageare positive integers. - Required fields missing: For creating or updating projects, required fields like name, number, description, and dates must be provided; otherwise, the API may reject the request.
- Date format errors: Dates must be in ISO 8601 format; incorrect formats will cause errors.
- API endpoint errors: Check the base URL and network connectivity if requests fail.
- Permission issues: The API key used must have sufficient permissions to perform the requested actions.
Links and References
- Workspace API Documentation (Replace with actual API docs link)
- ISO 8601 Date Format
- n8n Credentials Setup