Plane icon

Plane

Consume Plane API

Actions63

Overview

This node interacts with the Plane API to manage issue properties within a project management context. Specifically, the "Update" operation for the "Issue Property" resource allows users to modify attributes of an existing issue property associated with a particular issue type in a project.

Use cases include updating metadata about custom fields or properties that issues can have, such as changing their display name, description, whether they are required, active, allow multiple selections, or setting default values. This is useful when adapting issue tracking schemas dynamically without recreating properties from scratch.

Practical example: Suppose you have an issue property representing "Severity" with options like Low, Medium, High. You might want to update its description to clarify what each level means or mark it as required for new issues. Using this node operation, you can automate these updates as part of your workflow.

Properties

Name Meaning
Project ID The unique identifier of the project where the issue property exists.
Issue Type ID The unique identifier of the issue type to which the property belongs.
Property ID The unique identifier of the specific issue property to update.
Update Fields A collection of fields to update on the issue property, including:
- Display Name New display name for the issue property.
- Description Updated description text explaining the purpose or usage of the property.
- Is Required Boolean indicating if the property must be filled when creating issues (true/false).
- Is Active Boolean indicating if the property is currently active and usable (true/false).
- Is Multi Boolean indicating if multiple values can be selected (applicable for option-type properties).
- Default Value Default value for the property; for option types, this should be in JSON format.

Output

The output is a JSON object representing the updated issue property as returned by the Plane API. It typically includes all current attributes of the property after the update, such as its ID, display name, description, status flags (required, active, multi), and default value.

No binary data output is involved in this operation.

Dependencies

  • Requires access to the Plane API with appropriate authentication credentials (an API key or token).
  • The node expects the user to provide valid project ID, issue type ID, and property ID.
  • Network connectivity to the Plane API endpoint is necessary.
  • No additional external services or environment variables are explicitly required beyond standard API authentication.

Troubleshooting

  • Common Issues:

    • Providing incorrect or non-existent project, issue type, or property IDs will result in API errors.
    • Invalid JSON format in the "Default Value" field for option-type properties may cause request failures.
    • Attempting to update immutable fields or using unsupported property types could lead to errors.

  • Error Messages:

    • Errors from the Plane API will typically indicate missing or invalid identifiers.
    • Validation errors may occur if required fields are missing or contain invalid data types.
    • Network or authentication errors if the API key is missing or invalid.

  • Resolutions:

    • Double-check all IDs and ensure they exist in the Plane system.
    • Validate JSON formatting for complex fields before submission.
    • Ensure the API credential used has sufficient permissions to perform updates.
    • Use the node's "Continue On Fail" option to handle individual item errors gracefully in batch operations.

Links and References

Discussion