DatenMeister WebAPI Documentation

This endpoint allows for the immediate execution of an action by passing its definition as a JSON object in the request body. The user specifies the action name, which determines the specific logic to be applied to the provided parameters. It is particularly useful for ad-hoc operations that do not require a persisted action element in the workspace. The handler de-converts the JSON parameter into a DatenMeister element and evaluates it using the appropriate action handler. This method supports a broad range of actions, from simple logging to complex workspace manipulations like XMI import.

This endpoint triggers the execution of a pre-defined action that is already stored within a DatenMeister workspace. The caller provides the workspace ID and the unique URI of the action element to be evaluated. This approach is ideal for running complex, reusable workflows that have been configured and persisted in the modeling environment. The system resolves the action element from the specified workspace and executes it using the standard ActionLogic framework. It provides a way to decouple the triggering of an action from its detailed configuration. The result of the execution is returned in a standard format, including any output data.

This method retrieves a human-readable representation of a specific item identified by its workspace, extent, and item ID. It returns an ItemWithNameAndId object, which contains the item’s display name and unique identifier. This is a common operation for UI components that need to show labels for model elements without fetching their entire property set. The endpoint handles URL-encoded parameters to ensure that workspace and extent names are correctly processed. If the item cannot be found, a 404 Not Found response is returned. It is a fundamental building block for model browsing and navigation features.

This endpoint allows users to search for model elements using a simple text-based search string. It is useful for implementing global search or quick-find features in a modeling application. The search logic can return various types of results, such as direct references to items or extent-level references. The controller processes the search string and returns a structured result indicating the type of find and the associated item information. This simplifies the task of locating elements across large and complex model structures. The returned information is typically used to navigate the user to the found element.

This method creates a new, temporary DatenMeister element that is not yet persisted to a permanent workspace. Users can optionally specify a metaclass for the new element to define its structure and properties. The temporary element is stored in a special temporary workspace and is assigned a unique URI and ID. This feature is ideal for implementing "Create New" wizards where the user fills in data before committing the item to its final location. The resulting object contains all the information needed to identify and interact with the temporary element. It helps in managing the lifecycle of transient data during user interactions.

The QueryObject endpoint provides a powerful way to execute complex queries against the DatenMeister model. Users pass a query statement as a JSON object, which can include filtering, sorting, and transformation logic. The method evaluates the query using the DataView engine and returns the resulting objects or data sets. It also supports dynamic sources, allowing the query to be applied to specific collections or extents at runtime. This is the primary method for retrieving structured data from the system for reports, dashboards, or complex UI views. The response includes the query result and metadata like execution time and any error messages.

This method creates a new model item directly within a specified extent. The caller provides the workspace ID, the extent URI, and a set of parameters including the desired metaclass and initial property values. The controller uses a factory to instantiate the element and adds it to the root elements of the extent. This is the standard way to add new top-level items to a data model. The response includes the ID and URI of the newly created item, allowing the caller to perform further operations on it immediately. Initial properties are set during creation to ensure the item is in a valid state from the start.

This endpoint allows for the creation of a new item as a child of an existing element. The parent element is identified by its workspace and URI, and the new item is added to its containment structure. This is essential for building hierarchical models where elements are nested within one another. The caller can specify the metaclass for the child and whether it should be added to a specific list property. This method ensures that the parent-child relationship is correctly established in the underlying model. Like other creation methods, it returns the ID and URI of the new child element for further use.

This method removes a specific item from the DatenMeister environment. The item is identified by its workspace ID and its full URL or URI. The controller resolves the item and uses the standard deletion logic to remove it from its container. This operation is permanent and will remove the item and all its contained children from the model. It is a fundamental part of the data lifecycle management provided by the API. The response indicates whether the deletion was successful.

This endpoint retrieves a single item from the model and returns its full JSON representation. It can be accessed either by specifying the workspace, extent, and item ID, or by providing the workspace and item URI. The controller uses a JSON converter to serialize the element, including its properties and potentially its immediate children. The recursion depth and reference resolution can be configured to control the size and detail of the returned JSON. This is the primary method for fetching the state of a specific model element for display or processing. If the item is not found, a 404 response is returned.

This method updates the value of a specific property on a DatenMeister element. The element is identified by its workspace and URI, and the property is specified by its key in the request body. The value is passed as a string and is assigned to the property, potentially overwriting any existing value. This is a common operation for fine-grained updates to model data. The controller ensures that the property is correctly set and returns a success indication. It is ideal for simple attribute updates like changing a name or description.

This simple endpoint checks whether an extent with a given URI exists within a specific workspace. It is a useful utility for checking the state of the system before performing operations that depend on the presence of certain data sets. The method returns a structured result containing a boolean flag. It helps in implementing defensive programming patterns in client applications. The check is performed efficiently against the workspace logic. It requires the workspace ID and the extent URI as input.

This endpoint enables the creation of a new Xmi-backed extent in a specified workspace. The caller provides a file path where the XMI data will be stored and a unique URI for the extent. This is a powerful feature for dynamically adding new file-based data sources to the DatenMeister environment. The controller uses the ExtentManager to create the extent and register it with the workspace. It can also be configured to skip creation if an extent with the same URI already exists. This method is crucial for setting up persistent data storage via the WebAPI.

This method removes an entire extent from a workspace, effectively unloading the data. The caller specifies the workspace ID and the URI of the extent to be deleted. The controller uses the ExtentManager to perform the removal, which unregisters the extent from the workspace logic. This operation does not necessarily delete the underlying physical file, depending on the provider configuration. It is an essential tool for managing the lifecycle of data containers. The result indicates whether the deletion was successful or if it was skipped.

This endpoint allows for the programmatic creation of a new workspace in the DatenMeister environment. The caller provides a unique ID for the workspace and an optional annotation for descriptive purposes. The controller registers the new workspace with the global workspace logic, making it available for adding extents and elements. This is essential for setting up multi-workspace architectures dynamically. The method returns a success status indicating whether the workspace was created. If a workspace with the same ID already exists, the operation might fail depending on system state.

This method removes a specified workspace from the DatenMeister environment. The workspace is identified by its unique ID passed in the request body. Deleting a workspace is a major operation that unregisters it from the system and makes its contents inaccessible. It is used for cleaning up entire projects or data segments that are no longer required. The controller performs the removal through the workspace logic and returns a success status. This operation should be used with caution as it affects all data contained within the workspace.

This endpoint returns a list of all types and metaclasses currently registered in the DatenMeister environment. The result is a collection of ItemWithNameAndId objects, providing a summary of each type. This is useful for populating type selection lists in user interfaces. The controller queries the local type support to gather all relevant type definitions from the system. It provides a quick way to see what kinds of elements can be created. The returned list can be used to navigate to detailed type definitions if needed.

This method retrieves the specific type defined for a certain property within a given metaclass. It requires the workspace ID where the metaclass is located, the metaclass URI, and the name of the property. This information is highly valuable for building smart UI components that can adapt to the expected data type of a property (e.g., choosing a checkbox for a boolean or a date picker for a timestamp). The controller resolves the metaclass and inspects its properties using the UML classifier methods. It returns an ItemWithNameAndId representing the property’s type. This ensures that the UI remains consistent with the underlying model definition.

This endpoint triggers the creation of a pre-defined ZIP code example within a specified workspace. It is primarily used to demonstrate the system’s ability to handle ZIP archives and to provide a sample data set for users. The caller provides the target workspace ID where the example data should be added. The controller executes the example creation logic and returns the ID of the workspace and the URI of the newly created extent. This serves as a quick start guide for users exploring ZIP-related features. The operation is performed asynchronously to ensure a responsive API.