mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

This node interacts with the mittwald mStudio API to list project orders related to contracts. Specifically, it fetches a list of orders associated with a given project ID, allowing filtering and pagination. This is useful in scenarios where you need to retrieve contract order data for a specific project, such as generating reports, syncing order information with other systems, or monitoring order statuses.

Practical examples:

  • Fetching all orders for a project to display in a dashboard.
  • Filtering orders by status to identify pending or completed orders.
  • Paginating through large sets of orders to process them in batches.

Properties

Name Meaning
Project Id The unique identifier of the project whose orders you want to list.
Limit Maximum number of orders to return per request (pagination limit).
Skip Number of orders to skip before starting to collect the result set (offset for pagination).
Page The page number to retrieve (alternative pagination parameter).
Includes Status List of order statuses to include in the results (filter).
Excludes Status List of order statuses to exclude from the results (filter).
Template Names List of template names to filter the orders by specific templates.

Output

The node outputs JSON data representing the list of project orders retrieved from the mittwald mStudio API. Each item in the output corresponds to an order with its details as provided by the API. The structure typically includes order identifiers, status, template name, and other relevant metadata.

No binary data output is indicated.

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, ensure it is provided and correctly formatted.
  • API authentication errors: Verify that the API key credential is valid and has necessary permissions.
  • Pagination issues: If no results are returned, check the limit, skip, and page parameters to ensure they are within valid ranges.
  • Filtering problems: Incorrectly formatted JSON arrays for includesStatus, excludesStatus, or templateNames may cause the API to reject the request or return unexpected results.
  • Network or API downtime: Handle possible network errors or API unavailability gracefully.

Links and References

Discussion