Plane icon

Plane

Consume Plane API

Overview

This node interacts with the "Link" resource of the Plane API, specifically supporting the "Get Many" operation. It retrieves multiple link records associated with a specific issue within a project. This is useful for scenarios where you want to fetch all external or internal references (links) related to an issue in a project management context.

Practical examples include:

  • Gathering all URLs or references linked to a particular issue to display or process them further.
  • Automating reporting or auditing tasks that require collecting all related links for issues.
  • Integrating with other systems by fetching issue-related links and syncing or analyzing them.

Properties

Name Meaning
Project ID The unique identifier of the project containing the issue. Required to scope the request.
Issue ID The unique identifier of the issue whose links are to be retrieved.

Output

The output is a JSON array where each element represents a link object associated with the specified issue. Each link object typically contains details such as the URL and any additional metadata provided by the Plane API about that link.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Plane API via an API key credential configured in n8n.
  • The node uses internal helper functions to make authenticated HTTP requests to the Plane API endpoints.
  • The user must provide valid Project ID and Issue ID parameters to successfully retrieve links.

Troubleshooting

  • Common Issues:

    • Missing or invalid Project ID or Issue ID will cause the API request to fail.
    • Network connectivity problems or incorrect API credentials can lead to authentication errors.
    • If the issue has no links, the output will be an empty array, which is expected behavior.
  • Error Messages:

    • Errors from the Plane API will be propagated, often indicating missing resources or permission issues.
    • If the node throws an error about missing binary data, it indicates misuse of operations unrelated to "Get Many" on links.
  • Resolution Tips:

    • Verify that the Project ID and Issue ID correspond to existing entities in your Plane workspace.
    • Ensure the API key credential is correctly set up and has sufficient permissions.
    • Check network access and Plane API service status if requests fail unexpectedly.

Links and References

Discussion