mittwald icon

mittwald

Interact with mittwald mStudio API

Actions100

Overview

This node operation allows you to list AppInstallations associated with a specific Project in the mittwald mStudio API. It is useful when you want to retrieve and manage the installations of apps within a project, for example, to monitor which apps are installed, filter them by certain criteria, or paginate through large sets of app installations.

Practical examples include:

  • Fetching all app installations for a given project to display in a dashboard.
  • Filtering app installations by specific app IDs or search terms to find particular versions or descriptions.
  • Paginating through app installations when dealing with many entries.

Properties

Name Meaning
Project Id The ID of the Project whose AppInstallations you want to list. This is required.
App Ids A JSON array of App IDs to filter the installations by. Only installations of these apps will be returned.
Search Term A string to filter installations by searchable fields: id, shortId, description, appVersion, systemSoftwareVersion.
Limit Maximum number of AppInstallations to return in the response.
Skip Number of items to skip in the result set. Should be a multiple of limit. Used for pagination.
Page Page number to display. Functions similarly to skip. If both page and skip are set, skip takes precedence.

Output

The node outputs a JSON array of AppInstallation objects matching the query parameters. Each object typically contains details such as installation ID, app version, description, and related metadata. The exact structure depends on the mittwald mStudio API response schema for AppInstallations.

No binary data output is indicated for this operation.

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 Project Id: Since Project Id is required, omitting it or providing an incorrect value will likely cause errors or empty results.
  • Pagination issues: Setting skip incorrectly (not a multiple of limit) may lead to unexpected results or API errors.
  • API authentication errors: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Filtering with invalid App Ids or search terms: May result in no data returned; verify that filters match existing data.
  • Rate limiting or network errors: Handle API rate limits or connectivity problems gracefully in your workflow.

Links and References

Discussion