mittwald icon

mittwald

Interact with mittwald mStudio API

Actions100

Overview

This node allows users to update (patch) an existing app installation in the mittwald mStudio platform. It is useful for modifying details of an app installation such as its version, description, system software configuration, update policy, and user inputs without needing to recreate the installation from scratch.

Common scenarios include:

  • Updating the app version to a newer release.
  • Changing the root directory where the app's documents reside.
  • Adjusting the update policy to control automatic updates.
  • Modifying metadata like description or system software details.
  • Providing or updating custom user inputs related to the app installation.

Practical example: A user wants to upgrade their installed app to a new version while specifying a custom document root and enabling patch-level automatic updates. This node facilitates sending those changes to the API seamlessly.

Properties

Name Meaning
App Installation Id The unique identifier of the app installation to be updated (required).
App Version Id The identifier of the app version to update to.
Custom Document Root A custom path specifying the document root for the app installation.
Description A textual description or notes about the app installation.
System Software JSON object describing the system software environment or configuration related to the app.
Update Policy Defines which updates should be applied automatically by the system. Options: None, Patch Level, All.
User Inputs JSON array containing user-defined input parameters relevant to the app installation.

Output

The node outputs JSON data representing the response from the mittwald mStudio API after patching the app installation. This typically includes the updated state of the app installation resource with all modified fields reflected.

There is no indication that this node outputs binary data.

Dependencies

  • Requires an API key credential for authenticating with the mittwald mStudio API.
  • The base URL for API requests is https://api.mittwald.de.
  • The node uses standard HTTP headers for JSON content (Accept: application/json, Content-Type: application/json).

Troubleshooting

  • Missing or invalid App Installation Id: The node requires a valid app installation ID; ensure it is provided and correct.
  • Invalid JSON in System Software or User Inputs: These properties expect valid JSON strings; malformed JSON will cause errors.
  • API authentication errors: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Update Policy value errors: Only "none", "patchLevel", or "all" are accepted; other values will cause request failures.
  • Network or API downtime: Connectivity issues or API unavailability will result in errors; verify network access and API status.

Links and References

Discussion