mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

This node operation, "Extension List Extensions" under the "Marketplace" resource, is designed to retrieve a list of extensions from a marketplace API. It allows users to query and filter extensions based on various criteria such as context (project or customer), search terms, inclusion of deprecated extensions, pagination controls (limit, skip, page), and sorting options.

Common scenarios where this node would be beneficial include:

  • Displaying available extensions for a project or customer context in an automated workflow.
  • Searching for specific extensions by name or keyword.
  • Managing large sets of extensions with pagination and sorting.
  • Filtering out deprecated extensions if only current ones are needed.

Practical example:

  • A user wants to fetch all active extensions related to a particular project, sorted by name ascending, limiting results to 1000 entries per request.
  • Another use case could be searching for extensions containing a specific term while including deprecated ones for audit purposes.

Properties

Name Meaning
Context The context to list extensions for; options: "Project" or "Customer".
Search Term A string to filter extensions by matching names or descriptions.
Include Deprecated Boolean flag to include deprecated extensions in the results (true or false).
Limit Maximum number of extensions to return in one response (number).
Skip Number of items to skip for pagination; should be a multiple of limit.
Page Page number to display; functions similarly to skip. If both set, skip takes precedence.
Sort Field to sort the results by; currently supports sorting by "Name".
Order Sort order direction; options: "Asc" (ascending) or "Desc" (descending).

Output

The output of this node operation is a JSON array of extension objects retrieved from the marketplace API. Each object represents an extension with its associated metadata (such as name, status, description, etc.). The exact structure depends on the API response but typically includes identifiers, names, statuses, and other relevant extension details.

There is no indication that this node outputs binary data.

Dependencies

  • Requires an API key credential for authentication with the mittwald mStudio API.
  • The base URL for API requests is https://api.mittwald.de.
  • Uses standard HTTP headers for JSON content (Accept: application/json, Content-Type: application/json).
  • No additional external dependencies beyond the configured API credential and network access to the mittwald API.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing invalid pagination parameters (e.g., skip not a multiple of limit) may result in unexpected responses or errors.
    • Using unsupported sort fields or orders might lead to API errors or default sorting behavior.
    • Network connectivity issues can prevent successful API calls.

  • Error messages:

    • Authentication errors typically indicate problems with the API key or permissions.
    • Validation errors may occur if input parameters do not meet API requirements.
    • Rate limiting or quota exceeded errors if too many requests are made in a short time.

  • Resolutions:

    • Verify and configure a valid API key credential.
    • Ensure pagination parameters are consistent and valid.
    • Use supported values for sorting and filtering.
    • Check network connectivity and API service status.

Links and References

Discussion