Workspace icon

Workspace

Get and change data from Workspace API

Overview

The node interacts with a Workspace API to retrieve and manipulate data related to various resources, including Kanban boards. Specifically, for the "Kanban" resource and the "Get Kanban Card by ID" operation, the node fetches detailed information about a single Kanban card identified by its unique ID. This is useful in scenarios where you want to programmatically access the details of a specific task or item on a Kanban board, such as retrieving status, description, assignees, or other metadata associated with that card.

Practical examples include:

  • Automating project management workflows by fetching card details to update other systems.
  • Triggering notifications or reports based on the current state of a Kanban card.
  • Integrating Kanban data into dashboards or analytics tools.

Properties

Name Meaning
Kanban Card ID Unique identifier of the Kanban card to fetch details. This must be provided to specify which card's information to retrieve.

Output

The node outputs JSON data representing the detailed information of the requested Kanban card. The structure typically includes fields such as card ID, title, description, status, assigned users, due dates, and any custom fields defined in the Kanban system.

If the node supports binary data output (not evident from the provided code), it would represent attachments or files linked to the Kanban card, but this is not explicitly indicated here.

Dependencies

  • Requires an API key credential and tenant identification to authenticate requests against the Workspace API.
  • Needs the base URL of the Workspace API configured in the node credentials.
  • The node sends HTTP requests with appropriate headers including Accept, Content-Type, APIKEY, and TENANT.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Kanban Card ID will likely result in an error or empty response.
    • Missing or incorrect API credentials will cause authentication failures.
    • Network connectivity problems or incorrect API base URL configuration can prevent successful API calls.
  • Error messages:

    • Authentication errors indicating invalid API key or tenant should be resolved by verifying credentials.
    • "Card not found" or similar errors suggest the provided Kanban Card ID does not exist; double-check the ID.
    • Timeout or connection errors require checking network settings and API availability.

Links and References

  • Refer to the Workspace API documentation for detailed schema of Kanban card objects and supported operations.
  • Consult your Workspace API provider for instructions on obtaining API keys and tenant identifiers.

Discussion