Plane icon

Plane

Consume Plane API

Overview

This node interacts with the Plane API to manage issue properties within a project management context. Specifically, for the "Issue Property" resource and the "Get" operation, it retrieves detailed information about a specific property of an issue type in a given project.

Use cases include:

  • Fetching metadata or configuration details about custom properties defined for issues in a project.
  • Integrating issue property data into workflows for reporting, automation, or synchronization with other systems.
  • Validating or displaying issue property settings before creating or updating issues.

Example: You want to retrieve the definition of a custom field (issue property) used in your project's bug tracking system to display its attributes or use its values in subsequent workflow steps.

Properties

Name Meaning
Project ID The unique identifier of the project containing the issue type.
Issue Type ID The unique identifier of the issue type whose property you want to get.
Property ID The unique identifier of the specific issue property to retrieve.

Output

The output is a JSON object representing the requested issue property. It contains all the details returned by the Plane API for that property, such as its name, display name, type, and any additional metadata associated with the property.

No binary data output is involved in this operation.

Dependencies

  • Requires access to the Plane API via an authenticated API key credential configured in n8n.
  • The node uses internal helper functions to make HTTP requests to the Plane API endpoints.
  • The user must provide valid identifiers for the project, issue type, and property to successfully retrieve the data.

Troubleshooting

  • Common Issues:

    • Invalid or missing Project ID, Issue Type ID, or Property ID will cause the API request to fail.
    • Network connectivity or authentication errors with the Plane API can prevent data retrieval.
    • If the specified property does not exist, the API will return an error or empty response.
  • Error Messages:

    • Errors related to "Not Found" usually indicate incorrect IDs.
    • Authentication errors suggest misconfigured or expired API credentials.
    • To resolve, verify all input IDs are correct and ensure the API key credential is properly set up and has necessary permissions.

Links and References

  • Plane API Documentation (general reference for endpoints)
  • n8n documentation on HTTP Request Node for understanding API calls
  • Plane project and issue management concepts for context on issue properties and types

Discussion