Workspace icon

Workspace

Get and change data from Workspace API
Join our community

Actions22

Overview

The node interacts with a Workspace API to manage project efforts data. It allows users to retrieve, create, update, and delete effort entries associated with projects and their containers. This is useful for project management scenarios where tracking the amount of work (effort) allocated or spent on various parts of a project is necessary.

Typical use cases include:

  • Fetching all effort records for a project to analyze resource allocation.
  • Creating new effort entries when planning or logging work done.
  • Updating existing effort entries to reflect changes in planned or remaining work.
  • Deleting obsolete or incorrect effort entries.

For example, a project manager can use this node to pull all efforts related to a specific container within a project to review team workload or add new effort estimates for upcoming tasks.

Properties

Name Meaning
Action The operation to perform on project efforts. Options: Get Many, Get All Efforts for Container, Create Container Efforts Entry, Update Container Efforts Entry, Delete Container Efforts Entry.
Effort Entry ID The unique identifier of an effort entry. Required for updating or deleting a specific effort.
Project ID The unique identifier of the project to which the efforts belong.
Container ID The unique identifier of the container within the project. Required for most actions except "Get Many".
Page The page number to fetch when retrieving paginated results (for "Get Many" and "Get All Efforts for a Container").
Results Per Page Number of effort entries to fetch per page (for "Get Many" and "Get All Efforts for a Container").
Create Effort A collection of fields used when creating or updating an effort entry:
- Resource ID Unique identifier of the assigned resource (e.g., user or team member).
- Planned Effort Planned effort in hours.
- Remaining Effort Remaining effort in hours.
- Hours Per Day Planned working hours per day.

Output

The node outputs JSON data representing the effort entries retrieved or affected by the action. The structure typically includes details such as effort IDs, associated resource IDs, planned and remaining effort hours, and other metadata related to the project container efforts.

If the action involves fetching multiple efforts, the output will be a list of effort objects with pagination information if applicable.

No binary data output is indicated in the source or properties.

Dependencies

  • Requires connection to the Workspace API via an API key credential and tenant identification.
  • The node expects the base URL and authentication headers to be configured through n8n credentials.
  • No additional external dependencies are indicated.

Troubleshooting

  • Common issues:

    • Missing or incorrect Project ID or Container ID parameters may cause API requests to fail.
    • Pagination parameters (page, resultsPerPage) must be valid positive numbers; otherwise, the API might return errors or empty results.
    • When creating or updating efforts, ensure that numeric fields like plannedEffort, remainingEffort, and hoursPerDay are valid numbers.

  • Error messages:

    • Authentication errors if API key or tenant info is missing or invalid.
    • 404 Not Found if specified project, container, or effort IDs do not exist.
    • Validation errors if required fields are missing during creation or update.

  • Resolution tips:

    • Double-check all IDs and parameter values before execution.
    • Verify API credentials and endpoint configuration.
    • Use the "Get Many" or "Get All Efforts for a Container" actions first to confirm available IDs.

Links and References

Discussion