Plane icon

Plane

Consume Plane API
Join our community

Actions63

Overview

This node interacts with the Plane API to manage issue property options within a project management context. Specifically, for the "Issue Property Option" resource and the "Create" operation, it allows users to add new selectable options to an issue property in a given project. This is useful when customizing issue properties that have predefined sets of options, such as dropdowns or multi-select fields.

Common scenarios include:

  • Adding new choices to a custom field on issues (e.g., adding a new status option or category).
  • Extending existing issue properties dynamically without manual API calls.
  • Automating project setup or updates by programmatically managing issue property options.

Example: You have an issue property called "Priority Level" with options like "Low", "Medium", and "High". Using this node, you can create a new option "Urgent" to be available for selection in issues.

Properties

Name Meaning
Project ID The unique identifier of the project where the issue property option will be created.
Property ID The unique identifier of the issue property to which the option belongs.
Name The name of the new option to create under the specified issue property.
Additional Fields Optional extra settings for the option:
- Description A textual description explaining the option.
- Sort Order Numeric value defining the order in which the option appears (default is 10000).
- Is Active Boolean indicating if the option is currently active (default true).
- Is Default Boolean indicating if this option should be the default selection (default false).
- Parent ID Identifier of a parent option, allowing nested options (for hierarchical option structures).

Output

The output JSON contains the response from the Plane API after creating the issue property option. It typically includes details about the newly created option such as its ID, name, description, sort order, active status, default status, and any parent-child relationships.

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 depends on internal helper functions to make HTTP requests to the Plane API endpoints.
  • The user must provide valid Project ID and Issue Property ID values corresponding to existing entities in Plane.

Troubleshooting

  • Missing Required Parameters: Ensure that both Project ID and Property ID are provided; otherwise, the API call will fail.
  • Invalid IDs: If the Project ID or Property ID does not exist or is incorrect, the API will return an error.
  • Permission Issues: The API key used must have sufficient permissions to create options in the specified project.
  • API Errors: Network issues or Plane API downtime may cause request failures.
  • Option Name Conflicts: Creating an option with a name that already exists might result in errors or duplicates depending on API behavior.

To resolve errors:

  • Double-check all required input parameters.
  • Verify API credentials and permissions.
  • Review error messages returned by the node for specific API error codes or messages.

Links and References

Discussion