Plane icon

Plane

Consume Plane API

Overview

This node interacts with the Plane API to manage various project management resources, including issues, comments, labels, cycles, modules, and specifically for this request, issue property values. The "Get Values" operation under the "Issue Property Value" resource retrieves all values associated with a specific issue property within a project.

Use cases include:

  • Fetching all values assigned to a particular custom property of issues in a project.
  • Integrating issue property data into workflows for reporting or automation.
  • Synchronizing issue property values with other systems.

For example, if you have a custom property like "Severity" on issues, this operation can retrieve all the values set for that property across issues in a project.

Properties

Name Meaning
Project ID ID of the project
Issue ID ID of the issue

Note: The provided properties JSON shows only projectId and issueId as inputs, but the code for "issuePropertyValue" operations uses propertyId rather than issueId. The relevant parameters used in the code for "getValues" are projectId and propertyId.

Output

The output is a JSON array containing the retrieved issue property values. Each item corresponds to a value associated with the specified issue property in the given project.

The structure of each item depends on the Plane API's response for issue property values but typically includes identifiers and value details.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Plane API.
  • The node uses internal helper functions (planeApiRequest and planeApiRequestAllItems) to make HTTP requests to the Plane API endpoints.
  • No additional external services beyond the Plane API are required for this operation.

Troubleshooting

  • Common Issues:

    • Incorrect or missing projectId or propertyId will cause the API call to fail.
    • Network connectivity issues may prevent successful API requests.
    • Insufficient permissions or invalid API credentials will result in authorization errors.
  • Error Messages:

    • Errors from the Plane API will be propagated; typical messages might include "Not Found" if the project or property does not exist.
    • If no values are found, the output will be an empty array rather than an error.
    • If the node throws an error about missing binary data, it indicates misuse of operations unrelated to "Get Values".
  • Resolution:

    • Verify that the projectId and propertyId are correct and correspond to existing entities in Plane.
    • Ensure the API key credential is valid and has sufficient access rights.
    • Check network connectivity and retry if transient errors occur.

Links and References

  • Plane API Documentation (general reference for endpoints)
  • n8n documentation on creating and using custom nodes (for context on node development)

Additional Notes

The bundled source code shows that for the "issuePropertyValue" resource, the "getValues" operation calls:

GET /projects/{projectId}/issue-properties/{propertyId}/values

and returns all items from that endpoint.

The input properties you provided do not include propertyId, which is necessary according to the code. Make sure to provide propertyId when configuring this operation in n8n.

Discussion