Runn icon

Runn

Interact with Runn.io API

Overview

This node integrates with the Runn platform to manage various resources such as clients, projects, and people. Specifically, for the Projects resource with the Archive operation, it allows users to archive a project by its ID. Archiving a project typically means marking it as inactive or hidden without deleting it, which is useful for managing project lifecycle and keeping the workspace organized.

Common scenarios include:

  • Temporarily removing completed or paused projects from active views.
  • Keeping historical project data accessible but not cluttering current workflows.
  • Simulating the archiving process without making actual changes using the dry run option.

Example use case: Automatically archive projects that have been completed for over 6 months to keep the project list clean.

Properties

Name Meaning
ID The unique identifier of the project to be archived.
Dry Run When enabled (true), simulates the archiving operation without making any real changes in Runn.
Options Additional optional parameters (currently no specific options defined).

Output

The node outputs an array containing JSON objects representing the result of the archive operation. The exact structure depends on the Runn API response but generally includes confirmation of the archived project details.

If the operation fails and "Continue On Fail" is enabled, the output will contain an error message in the json.error field.

No binary data output is produced by this node.

Dependencies

  • Requires access to the Runn API via an authenticated connection using an API key or token.
  • The node depends on internal helper modules for handling API calls to Runn's projects endpoint.
  • Proper configuration of credentials and network access to Runn's service is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing project ID will cause the operation to fail.
    • Network or authentication errors if API credentials are incorrect or expired.
    • Attempting to archive a project that is already archived may result in an error or no change.
  • Error messages:

    • "Unsupported resource": Occurs if the resource parameter is set incorrectly.
    • API error messages returned from Runn will be surfaced; check the error text for details.
  • Resolutions:

    • Verify the project ID is correct and exists in your Runn account.
    • Ensure API credentials are valid and have sufficient permissions.
    • Use the Dry Run option to test the operation without affecting live data.

Links and References

Discussion