Plane icon

Plane

Consume Plane API

Overview

The node interacts with the "Cycle" resource of the Plane API, specifically supporting the "Update" operation. It allows users to update details of an existing cycle within a project by specifying the project ID and cycle ID along with fields to modify. This is useful for managing project cycles dynamically, such as changing cycle names, descriptions, or scheduling dates.

Practical scenarios include:

  • Renaming a cycle to reflect updated sprint goals.
  • Adjusting start or end dates of a cycle due to timeline changes.
  • Changing the owner of a cycle to reassign responsibility.

Properties

Name Meaning
Project ID The unique identifier of the project containing the cycle to update.
Cycle ID The unique identifier of the cycle to be updated.
Update Fields A collection of fields to update on the cycle. Options include:
- Name: New name of the cycle.
- Description: Updated description text for the cycle.
- Start Date: New start date/time for the cycle.
- End Date: New end date/time for the cycle.
- Owned By: User ID of the new owner responsible for the cycle.

Output

The output JSON contains the updated cycle object returned from the Plane API after the PATCH request. This typically includes all current properties of the cycle reflecting the applied updates.

No binary data output is involved in this operation.

Dependencies

  • Requires access to the Plane API with appropriate authentication (an API key credential).
  • The node uses internal helper functions to make HTTP requests to the Plane API endpoints.
  • The user must configure the Plane API credentials in n8n before using this node.

Troubleshooting

  • Missing Required IDs: If either Project ID or Cycle ID is not provided or invalid, the API call will fail. Ensure these are correctly set.
  • Invalid Field Values: Providing incorrectly formatted dates or invalid user IDs for ownership may cause errors.
  • API Authentication Errors: Ensure the Plane API credentials are valid and have sufficient permissions.
  • Network Issues: Connectivity problems can cause request failures; verify network access to the Plane API endpoint.
  • Error Messages: The node throws errors with messages from the Plane API. Review these messages to identify issues like "Not Found" (invalid IDs) or "Unauthorized" (credential issues).

Links and References

Discussion