Workspace icon

Workspace

Get and change data from Workspace API
Join our community

Actions22

Overview

The node named "Workspace" integrates with a Workspace API to manage project containers. It supports operations to retrieve multiple containers, get details of a specific container, create new containers, and update existing ones within a project context.

This node is beneficial in scenarios where users need to automate project management workflows, such as syncing container data from the Workspace API into other systems, managing project timelines, or updating container progress programmatically.

Practical examples include:

  • Fetching all containers for a given project to display in a dashboard.
  • Creating a new container when a new phase or task group starts in a project.
  • Updating container details like name, description, responsible person, or progress based on external triggers or user input.

Properties

Name Meaning
Action The operation to perform on project containers. Options: Get Many, Get Container Details by ID, Create Container, Update Container.
Project ID The unique identifier of the project (required for fetching multiple containers or creating a container).
Container ID The unique identifier of the container (required for getting details or updating a container).
Page The page number to fetch when retrieving multiple containers (pagination support).
Results Per Page Number of containers to fetch per page when retrieving multiple containers.

Create Container Fields (used when Action = Create Container)

Name Meaning
Project ID Unique identifier of the project (required).
Name Name of the new container (required).
Description Detailed description of the container.
Responsible ID Unique identifier of the person responsible for the container (required).
Start Date Start date of the container (required).
End Date End date of the container (required).

Update Container Fields (used when Action = Update Container)

Name Meaning
Name New name of the container.
Description New description of the container.
Start Date New start date of the container.
End Date New end date of the container.
Responsible ID New unique identifier of the responsible person.
Progress New progress value expressed as a percentage.

Output

The node outputs JSON data representing the response from the Workspace API corresponding to the selected action:

  • For Get Many, it returns a paginated list of containers with their details.
  • For Get Container Details by ID, it returns detailed information about a single container.
  • For Create Container, it returns the newly created container's data.
  • For Update Container, it returns the updated container's data.

If binary data were involved, it would be summarized here, but this node deals exclusively with JSON data related to project containers.

Dependencies

  • Requires an API key credential and tenant identifier configured in n8n credentials to authenticate requests to the Workspace API.
  • The base URL for the Workspace API must be set in the node credentials.
  • The node uses HTTP methods GET, POST, and PATCH to interact with the API endpoints under /api/v2/containers.

Troubleshooting

  • Missing or invalid API credentials: Ensure that the API key, tenant, and base URL are correctly configured in the node credentials.
  • Invalid Project ID or Container ID: Verify that the IDs provided exist and are correct; otherwise, the API will return errors indicating not found.
  • Pagination parameters out of range: When using "Get Many," ensure page and resultsPerPage are positive integers within allowed limits.
  • Required fields missing during creation or update: Make sure all required fields (e.g., projectId, name, responsibleId, startDate, endDate) are provided when creating or updating a container.
  • API endpoint errors: Check the API documentation for error codes returned by the Workspace API and adjust inputs accordingly.

Links and References

Discussion