MagicDraw 2026x API

https://jdocs.nomagic.com/2026x
Admin
MagicDraw is a comprehensive UML and SysML modeling platform that provides APIs for creating...
Tokens:3,782,513
Snippets:29,384
Trust Score:9.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### getStartTime

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/simulation/SimulationProfile.SimulationConfigStereotype.html

Gets the start time for the simulation.

```APIDOC
## getStartTime

### Description
Gets the start time for the simulation.

### Method
`getStartTime`

### Parameters
#### Path Parameters
- **element** (Element) - Required - The element to get the property on.

### Response
#### Success Response (Integer)
- **Integer** - The start time value, or null if not set.
```

--------------------------------

### setUpTest

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/tests/MagicDrawTestCase.html

Allows for test case preparation after the MagicDraw application has started. This method should be overridden for test setup, and the default JUnit setUp() should not be used instead.

```APIDOC
## Method Details

### setUpTest
@OpenApi protected void setUpTest() throws Exception
Override to prepare test case after MagicDraw application started. Test set up should be done here. Do not use default JUnit setUp() instead.
```

--------------------------------

### install

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/uml/symbols/DiagramListenerAdapter.html

Installs the DiagramListenerAdapter to a project, enabling it to receive diagram change events.

```APIDOC
## install(Project project)

### Description
Installs the DiagramListenerAdapter to a project. Once installed, the adapter will begin listening for diagram content change events.

### Method
install

### Parameters
#### Path Parameters
* **project** (Project) - The project to which the adapter should be installed.

### See Also
* `uninstall(Project)`
```

--------------------------------

### Example: Listen to Symbol Creation/Deletion

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/uml/symbols/DiagramListenerAdapter.html

Demonstrates how to create, install, and uninstall a DiagramListenerAdapter to listen for symbol (PresentationElement) additions or removals. The adapter is uninstalled when no longer needed.

```java
DiagramListenerAdapter adapter = new DiagramListenerAdapter(new PropertyChangeListener()
{
        public void propertyChange(PropertyChangeEvent evt)
     {
                String propertyName = evt.getPropertyName();
                if (ExtendedPropertyNames.VIEW_ADDED.equals(propertyName) ||
                        ExtendedPropertyNames.VIEW_REMOVED.equals(propertyName))
         {
                        // added/removed symbol
                        PresentationElement presentationElement = (PresentationElement) evt.getNewValue();
         }
     }
});

adapter.install(project);

// When it is no longer needed, uninstall it.
adapter.uninstall(project);
```

--------------------------------

### start()

Source: https://jdocs.nomagic.com/2026x/com/nomagic/uml2/transaction/ModelTransaction.html

Starts a new transaction. Events will be recorded and analyzed after the transaction begins.

```APIDOC
## start()

### Description
Starts a new transaction. Events will be recorded and analyzed after the transaction begins.

### Method
public void start()

### Endpoint
N/A (SDK Method)

### Parameters
None

### Response
None
```

--------------------------------

### Auto Start

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/simulation/SimulationProfile.SimulationConfigStereotype.html

Methods for managing the 'Auto Start' property.

```APIDOC
## Auto Start

### setAutoStart

Sets the 'Auto Start' property for a given element.

- **element** (Element) - The element to configure.
- **value** (Boolean) - The value to set (true or false).

### clearAutoStart

Clears the 'Auto Start' property for a given element.

- **element** (Element) - The element to clear the property for.

### isAutoStart

Checks if the 'Auto Start' property is enabled for a given element.

- **element** (Element) - The element to check.

**Returns**: Boolean - True if enabled, false otherwise.
```

--------------------------------

### Install DiagramListenerAdapter

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/uml/symbols/DiagramListenerAdapter.html

Installs the DiagramListenerAdapter to a project, enabling it to receive diagram change events.

```java
adapter.install(project);
```

--------------------------------

### Get GUID

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/sysml/util/MDCustomizationForSysMLProfile.FmuStereotype.html

Retrieves the GUID for a given element.

```APIDOC
## getGUID

### Description
Retrieves the GUID for the specified element.

### Method
GET

### Endpoint
N/A (Java method)

### Parameters
#### Path Parameters
- **element** (Element) - Required - The element to retrieve the GUID from.

### Returns
String - The GUID value, or null if not set.
```

--------------------------------

### setupEngine

Source: https://jdocs.nomagic.com/2026x/com/nomagic/reportwizard/tools/importer/DOCXImporterTool.html

Sets up the engine by adding properties and context to it.

```APIDOC
## setupEngine

### Description
Sets up the engine by adding properties and context to it.

### Method
protected void setupEngine(ITemplateEngine engine)

### Parameters
* `engine` (ITemplateEngine) - The current engine to set up.
```

--------------------------------

### getSetupPart

Source: https://jdocs.nomagic.com/2026x/com/nomagic/uml2/ext/magicdraw/activities/mdstructuredactivities/LoopNode.html

Retrieves the collection of ExecutableNodes executed before the first loop iteration to initialize values or perform setup computations.

```APIDOC
## getSetupPart

### Description
Returns the value of the '_**Setup Part**_ ' reference list. This is a set of ExecutableNodes executed before the first iteration of the loop, in order to initialize values or perform other setup computations.

### Method
Collection<ExecutableNode>

### Returns
- the value of the '_Setup Part_ ' reference list.
```

--------------------------------

### setupTool

Source: https://jdocs.nomagic.com/2026x/com/nomagic/reportwizard/tools/ImportTool.html

Sets required properties and observers for the importer tool.

```APIDOC
## setupTool

### Description
Set required properties and observer to importer tool.

### Method
public void setupTool(DefaultImporterTool importerTool)

### Parameters
#### Path Parameters
* **importerTool** (DefaultImporterTool) - Required - current importer tool
```

--------------------------------

### getExamplesDirectory

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/core/Application.Environment.html

Gets the directory where examples are located.

```APIDOC
## getExamplesDirectory

### Description
Gets directory of examples.

### Method
public String getExamplesDirectory()

### Returns
- examples directory (String)
```

--------------------------------

### Application.start()

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/core/Application.html

Starts the MagicDraw application with various configuration options.

```APIDOC
## Application.start(String[] args)

### Description
Starts the MagicDraw application using the provided command line arguments.

### Method
POST

### Endpoint
N/A (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **args** (String[]) - Command line arguments passed to MagicDraw.

### Request Example
```json
{
  "example": {
    "args": ["-path/to/project.mdzip"]
  }
}
```

### Response
#### Success Response (200)
None (typically exits or continues application execution).

### Response Example
None
```

```APIDOC
## Application.start(boolean guiVisible, boolean silentMode, boolean tryToLoadProject, String[] args, StartupParticipant participant)

### Description
Starts the MagicDraw application with detailed control over visibility, mode, project loading, arguments, and startup participants.

### Method
POST

### Endpoint
N/A (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **guiVisible** (boolean) - Determines if the MagicDraw GUI should be visible.
- **silentMode** (boolean) - If true, the GUI operates in silent (batch) mode.
- **tryToLoadProject** (boolean) - If true, the application attempts to load a project file specified in the arguments.
- **args** (String[]) - Command line arguments passed to MagicDraw.
- **participant** (StartupParticipant) - An optional participant in the startup process.

### Request Example
```json
{
  "example": {
    "guiVisible": true,
    "silentMode": false,
    "tryToLoadProject": true,
    "args": ["-path/to/project.mdzip"],
    "participant": null
  }
}
```

### Response
#### Success Response (200)
None (typically exits or continues application execution).

### Response Example
None
```

--------------------------------

### getInstallRoot

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/core/Application.Environment.html

Gets the application installation root directory.

```APIDOC
## getInstallRoot

### Description
Gets application installation root.

### Method
public String getInstallRoot()

### Returns
- application installation root (String)
```

--------------------------------

### Opening a Project via Command Line

Source: https://jdocs.nomagic.com/2026x/allclasses-index.html

This example demonstrates how to launch MagicDraw from the command line to open a specific project. It outlines the default arguments that can be used for project opening, including project path, server details, and authentication credentials.

```java
Arguments are specified as name=value pairs.  
Default arguments that will be used to try and open project: project - Project name or path projectDescriptor - Project descriptor server - Server url username - Username on server password - Password for provided username enableSSL - To use ssl serverType - Should be any value of `ServerType`, if not specified `ServerType.TEAMWORK_CLOUD` will be used encryptPassword - Set true if provided password is in plain text properties - Path to properties file containing properties.
```

--------------------------------

### StartBoundaryType Methods

Source: https://jdocs.nomagic.com/2026x/com/nomagic/updm/utils/UPDMProfile.EnvironmentPropertyStereotype.html

Methods for setting, clearing, and getting the start boundary type.

```APIDOC
## StartBoundaryType Methods

### setStartBoundaryType

Sets the start boundary type for a given element.

`public void setStartBoundaryType(Element element, @CheckForNull Element value)`

### clearStartBoundaryType

Clears the start boundary type for a given element.

`public void clearStartBoundaryType(Element element)`

### getStartBoundaryType

Gets the start boundary type for a given element.

`@CheckForNull public Element getStartBoundaryType(Element element)`
```

--------------------------------

### init (with description, min, max)

Source: https://jdocs.nomagic.com/2026x/com/nomagic/task/EmptyProgressStatus.html

Initializes the progress status with a description, minimum, and maximum value.

```APIDOC
## Method: init

### Description
Initializes the progress status with a description, minimum, and maximum value.

### Method
`public void init(String description, long min, long max)`

### Parameters
* **description** (String) - The description for the progress.
* **min** (long) - The minimum value for the progress.
* **max** (long) - The maximum value for the progress.

### Inherited From
`com.nomagic.task.ProgressStatus`
```

--------------------------------

### getScenarioStart

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/usecasescenarios/scenarios/Scenario.html

Gets the scenario node that starts the scenario. This method is inherited from ScenarioNode.

```APIDOC
## getScenarioStart

### Description
Gets scenario node which starts scenario.

### Method
ScenarioNodeStart

### Endpoint
N/A (Method Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
N/A

### Response
#### Success Response (200)
- **scenarioNodeStart** (ScenarioNodeStart) - The scenario node that starts the scenario.

#### Response Example
{
  "example": "ScenarioNodeStart object"
}
```

--------------------------------

### init (String, long, long)

Source: https://jdocs.nomagic.com/2026x/com/nomagic/task/SimpleProgressStatus.html

Initializes the progress status with a description, minimum, and maximum values.

```APIDOC
## init

### Description
Initialize progress.

### Method
public void

### Parameters
#### Path Parameters
- **description** (String) - Required - progress description.
- **min** (long) - Required - minimum value.
- **max** (long) - Required - maximum value.

### Response
#### Success Response
void

```

--------------------------------

### setupChildEngine

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicreport/engine/ooxml/child/docx/DOCXChildEngineHelper.html

Sets up a specific engine to be a child engine of a parent engine. This involves initializing the engine with a template file and establishing the parent-child relationship.

```APIDOC
## setupChildEngine

### Description
Setup specific engine to be child engine of parentEngine.

### Method
public static void

### Parameters
#### Path Parameters
- **engine** (ITemplateEngine) - Required - current engine
- **parentEngine** (ITemplateEngine) - Required - parent engine
- **importedFile** (File) - Required - template file for current engine
```

--------------------------------

### RuleStereotype StartBoundaryType Management

Source: https://jdocs.nomagic.com/2026x/com/nomagic/updm/utils/UPDMProfile.RuleStereotype.html

Methods for setting, clearing, and getting the start boundary type of a RuleStereotype.

```APIDOC
## RuleStereotype StartBoundaryType Management

### Description
Manages the start boundary type associated with a RuleStereotype.

### Methods
- **setStartBoundaryType**(Element element, Element value): Sets the start boundary type for the given element.
- **clearStartBoundaryType**(Element element): Clears the start boundary type for the given element.
- **getStartBoundaryType**(Element element): Retrieves the start boundary type for the given element.
```

--------------------------------

### init (with description, min, max, cur)

Source: https://jdocs.nomagic.com/2026x/com/nomagic/task/EmptyProgressStatus.html

Initializes the progress status with a description, minimum, maximum, and current value.

```APIDOC
## Method: init

### Description
Initializes the progress status with a description, minimum, maximum, and current value.

### Method
`public void init(String description, long min, long max, long cur)`

### Parameters
* **description** (String) - The description for the progress.
* **min** (long) - The minimum value for the progress.
* **max** (long) - The maximum value for the progress.
* **cur** (long) - The current value for the progress.

### Inherited From
`com.nomagic.task.ProgressStatus`
```

--------------------------------

### Multiple Start Event Stereotype Methods

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.MultipleStartEventStereotype.html

Provides methods for managing properties of a Multiple Start Event stereotype, such as setting and getting its ID, interruptible status, data outputs, and associated elements.

```APIDOC
## Multiple Start Event Stereotype Operations

This section details the operations available for the Multiple Start Event stereotype.

### `setIsInterrupting(Element element, BPMN2Profile.isInterrupting_multipleEnum value)`
Sets the interrupting status for the element.

### `clearIsInterrupting(Element element)`
Clears the interrupting status for the element.

### `getIsInterrupting(Element element)`
Retrieves the interrupting status for the element.

### `setDataOutputAssociation(Element element, Collection<? extends Element> value)`
Sets the data output associations for the element.

### `clearDataOutputAssociation(Element element)`
Clears the data output associations for the element.

### `addDataOutputAssociation(Element element, Element value)`
Adds a data output association to the element.

### `removeDataOutputAssociation(Element element, Element value)`
Removes a data output association from the element.

### `getDataOutputAssociation(Element element)`
Retrieves the list of data output associations for the element.

### `setDataOutputs(Element element, Collection<? extends Element> value)`
Sets the data outputs for the element.

### `clearDataOutputs(Element element)`
Clears the data outputs for the element.

### `addDataOutputs(Element element, Element value)`
Adds a data output to the element.

### `removeDataOutputs(Element element, Element value)`
Removes a data output from the element.

### `getDataOutputs(Element element)`
Retrieves the list of data outputs for the element.

### `setOutputSet(Element element, Element value)`
Sets the output set for the element.

### `clearOutputSet(Element element)`
Clears the output set for the element.

### `getOutputSet(Element element)`
Retrieves the output set for the element.

### `setId(Element element, String value)`
Sets the ID for the element.

### `clearId(Element element)`
Clears the ID for the element.

### `getId(Element element)`
Retrieves the ID for the element.

### `setMessageRef(Element element, Element value)`
Sets the message reference for the element.

### `clearMessageRef(Element element)`
Clears the message reference for the element.

### `getMessageRef(Element element)`
Retrieves the message reference for the element.

### `setOperationRef(Element element, Element value)`
Sets the operation reference for the element.

### `clearOperationRef(Element element)`
Clears the operation reference for the element.

### `getOperationRef(Element element)`
Retrieves the operation reference for the element.

### `setSources(Element element, Collection<? extends Element> value)`
Sets the sources for the element.

### `clearSources(Element element)`
Clears the sources for the element.

### `addSources(Element element, Element value)`
Adds a source to the element.

### `removeSources(Element element, Element value)`
Removes a source from the element.

### `getSources(Element element)`
Retrieves the list of sources for the element.

### `setTargetLinkEvent(Element element, Element value)`
Sets the target link event for the element.

### `clearTargetLinkEvent(Element element)`
Clears the target link event for the element.

### `getTargetLinkEvent(Element element)`
Retrieves the target link event for the element.

### `setTimeCycle(Element element, String value)`
Sets the time cycle for the element.

### `clearTimeCycle(Element element)`
Clears the time cycle for the element.

### `getTimeCycle(Element element)`
Retrieves the time cycle for the element.

### `setTimeDate(Element element, String value)`
Sets the time date for the element.

### `clearTimeDate(Element element)`
Clears the time date for the element.

### `getTimeDate(Element element)`
Retrieves the time date for the element.

### `setTimeDuration(Element element, String value)`
Sets the time duration for the element.

### `clearTimeDuration(Element element)`
Clears the time duration for the element.

### `getTimeDuration(Element element)`
Retrieves the time duration for the element.
```

--------------------------------

### Boundary Type Property Management

Source: https://jdocs.nomagic.com/2026x/com/nomagic/updm/utils/UPDMProfile.FillsPostStereotype.html

Methods for getting, setting, and clearing the start and end boundary types associated with an element.

```APIDOC
## Boundary Type Property Management

### Description
Provides methods to manage the start and end boundary type properties of an element.

### Methods
* **getEndBoundaryTypeProperty**(): Property - Returns the property object for the end boundary type.
* **getStartBoundaryTypeProperty**(): Property - Returns the property object for the start boundary type.
* **setEndBoundaryType**(Element element, Element value): void - Sets the end boundary type for the given element.
* **clearEndBoundaryType**(Element element): void - Clears the end boundary type for the given element.
* **getEndBoundaryType**(Element element): Element - Retrieves the end boundary type for the given element.
* **setStartBoundaryType**(Element element, Element value): void - Sets the start boundary type for the given element.
* **clearStartBoundaryType**(Element element): void - Clears the start boundary type for the given element.
* **getStartBoundaryType**(Element element): Element - Retrieves the start boundary type for the given element.
```

--------------------------------

### init

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/simulation/engine/ExecutionEngine.html

Initializes the engine with a given element.

```APIDOC
## init(Element element)

### Description
Engine initialization.

### Parameters
#### Path Parameters
- **element** (Element) - the given element

### Method
abstract void
```

--------------------------------

### ActualPropertySetStereotype Methods

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/uaf/UAF.ActualPropertySetStereotype.html

Methods for interacting with the ActualPropertySetStereotype, including getting and setting properties like end date, start date, URI, and conformance.

```APIDOC
## Method Details

### `getStereotype()`
public Stereotype getStereotype()
Returns stereotype for this wrapper.

### `getEndDateProperty()`
@CheckForNull public Property getEndDateProperty()

### `getStartDateProperty()`
@CheckForNull public Property getStartDateProperty()

### `getURIProperty()`
@CheckForNull public Property getURIProperty()

### `getConformsToProperty()`
@CheckForNull public Property getConformsToProperty()

### `setEndDate(Element element, @CheckForNull Element value)`
public void setEndDate(Element element, @CheckForNull Element value)

### `clearEndDate(Element element)`
public void clearEndDate(Element element)

### `getEndDate(@CheckForNull Element element)`
@CheckForNull public Element getEndDate(Element element)

### `setStartDate(Element element, @CheckForNull Element value)`
public void setStartDate(Element element, @CheckForNull Element value)

### `clearStartDate(Element element)`
public void clearStartDate(Element element)

### `getStartDate(@CheckForNull Element element)`
@CheckForNull public Element getStartDate(Element element)

### `setURI(Element element, @CheckForNull String value)`
public void setURI(Element element, @CheckForNull String value)

### `clearURI(Element element)`
public void clearURI(Element element)

### `getURI(@CheckForNull Element element)`
@CheckForNull public String getURI(Element element)

### `setConformsTo(Element element, @CheckForNull Collection<? extends Element> value)`
public void setConformsTo(Element element, @CheckForNull Collection<? extends Element> value)

### `clearConformsTo(Element element)`
public void clearConformsTo(Element element)

### `addConformsTo(Element element, Element value)`
public void addConformsTo(Element element, Element value)

### `removeConformsTo(Element element, Element value)`
public void removeConformsTo(Element element, Element value)

### `getConformsTo(Element element)`
public List<Element> getConformsTo(Element element)

### `is(@CheckForNull Element element)`
public boolean is(@CheckForNull Element element)

### `isInstance(Element element)`
public static boolean isInstance(@CheckForNull Element element)
```

--------------------------------

### init (with description, max)

Source: https://jdocs.nomagic.com/2026x/com/nomagic/task/EmptyProgressStatus.html

Initializes the progress status with a description and maximum value.

```APIDOC
## Method: init

### Description
Initializes the progress status with a description and maximum value.

### Method
`public void init(String description, long max)`

### Parameters
* **description** (String) - The description for the progress.
* **max** (long) - The maximum value for the progress.

### Inherited From
`com.nomagic.task.ProgressStatus`
```

--------------------------------

### ActualMissionStereotype Methods

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/uaf/UAF.ActualMissionStereotype.html

Provides methods for managing UAF elements with the ActualMissionStereotype, including setting and getting URIs, conformance information, start dates, and end dates.

```APIDOC
## ActualMissionStereotype Class

This class represents the ActualMissionStereotype in the UAF profile.

### Methods

*   **`getStereotype()`**: Returns the stereotype for this wrapper.
*   **`getURIProperty()`**: Returns the Property object for the URI.
*   **`getConformsToProperty()`**: Returns the Property object for conformance information.
*   **`getEndDateProperty()`**: Returns the Property object for the end date.
*   **`getStartDateProperty()`**: Returns the Property object for the start date.
*   **`setURI(Element element, String value)`**: Sets the URI for the given element.
*   **`clearURI(Element element)`**: Clears the URI for the given element.
*   **`getURI(Element element)`**: Gets the URI for the given element.
*   **`setConformsTo(Element element, Collection<? extends Element> value)`**: Sets the conformance information for the given element.
*   **`clearConformsTo(Element element)`**: Clears the conformance information for the given element.
*   **`addConformsTo(Element element, Element value)`**: Adds a conformance value for the given element.
*   **`removeConformsTo(Element element, Element value)`**: Removes a conformance value for the given element.
*   **`getConformsTo(Element element)`**: Gets the conformance information for the given element.
*   **`setEndDate(Element element, Element value)`**: Sets the end date for the given element.
*   **`clearEndDate(Element element)`**: Clears the end date for the given element.
*   **`getEndDate(Element element)`**: Gets the end date for the given element.
*   **`setStartDate(Element element, Element value)`**: Sets the start date for the given element.
*   **`clearStartDate(Element element)`**: Clears the start date for the given element.
*   **`getStartDate(Element element)`**: Gets the start date for the given element.
*   **`is(Element element)`**: Checks if the given element has this stereotype.
*   **`isInstance(Element element)`**: Checks if the given element is an instance of this stereotype.

### Fields

*   **`CONFORMSTO`**: Relates a UAFElement to the Standard that the UAFElement is conforming to.
*   **`ENDDATE`**: End time for all "actual" elements.
*   **`STARTDATE`**: Start time for all "actual" elements.
*   **`STEREOTYPE_NAME`**: The name of the stereotype.
*   **`URI`**: Captures Unique identifier for the element.
```

--------------------------------

### MessageStartEventStereotype Methods

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.MessageStartEventStereotype.html

Provides methods for managing Message Start Events, including setting and getting attributes like ID, interrupting status, message references, and data outputs.

```APIDOC
## MessageStartEventStereotype Methods

### Description
Provides methods for managing Message Start Events, including setting and getting attributes like ID, interrupting status, message references, and data outputs.

### Methods

- **`addDataOutputAssociation(Element element, Element value)`**: Adds a data output association to the element.
- **`addDataOutputs(Element element, Element value)`**: Adds data outputs to the element.
- **`clearDataOutputAssociation(Element element)`**: Clears the data output association for the element.
- **`clearDataOutputs(Element element)`**: Clears the data outputs for the element.
- **`clearId(Element element)`**: Clears the ID of the element.
- **`clearIsInterrupting(Element element)`**: Clears the interrupting status of the element.
- **`clearMessageRef(Element element)`**: Clears the message reference for the element.
- **`clearOperationRef(Element element)`**: Clears the operation reference for the element.
- **`clearOutputSet(Element element)`**: Clears the output set for the element.
- **`getDataOutputAssociation(Element element)`**: Retrieves the data output association for the element.
- **`getDataOutputs(Element element)`**: Retrieves the data outputs for the element.
- **`getId(Element element)`**: Retrieves the ID of the element.
- **`getIsInterrupting(Element element)`**: Retrieves the interrupting status of the element.
- **`getMessageRef(Element element)`**: Retrieves the message reference for the element.
- **`getOperationRef(Element element)`**: Retrieves the operation reference for the element.
- **`getOutputSet(Element element)`**: Retrieves the output set for the element.
- **`getStereotype()`**: Returns the stereotype for this wrapper.
- **`is(Element element)`**: Checks if the element is associated with this stereotype.
- **`removeDataOutputAssociation(Element element, Element value)`**: Removes a data output association from the element.
- **`removeDataOutputs(Element element, Element value)`**: Removes data outputs from the element.
- **`setDataOutputAssociation(Element element, Collection<? extends Element> value)`**: Sets the data output association for the element.
- **`setDataOutputs(Element element, Collection<? extends Element> value)`**: Sets the data outputs for the element.
- **`setId(Element element, String value)`**: Sets the ID of the element.
- **`setIsInterrupting(Element element, BPMN2Profile.isInterrupting_messageEnum value)`**: Sets the interrupting status of the element.
- **`setMessageRef(Element element, Element value)`**: Sets the message reference for the element.
- **`setOperationRef(Element element, Element value)`**: Sets the operation reference for the element.
- **`setOutputSet(Element element, Element value)`**: Sets the output set for the element.

### Static Methods

- **`isInstance(Element element)`**: Checks if the given element is an instance of this stereotype.
```

--------------------------------

### ActualResourceStereotype Methods

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/uaf/UAF.ActualResourceStereotype.html

Provides methods for retrieving and manipulating properties of ActualResourceStereotype, including setting, clearing, adding, removing, and getting values for actual condition, milestones, URI, conformance, start date, and end date.

```APIDOC
## Methods

### `getStereotype`
public Stereotype getStereotype()
Returns stereotype for this wrapper.

### `getActualConditionProperty`
@CheckForNull public Property getActualConditionProperty()

### `getMilestoneProperty`
@CheckForNull public Property getMilestoneProperty()

### `getURIProperty`
@CheckForNull public Property getURIProperty()

### `getConformsToProperty`
@CheckForNull public Property getConformsToProperty()

### `getEndDateProperty`
@CheckForNull public Property getEndDateProperty()

### `getStartDateProperty`
@CheckForNull public Property getStartDateProperty()

### `setActualCondition`
public void setActualCondition(Element element, @CheckForNull Collection<? extends Element> value)

### `clearActualCondition`
public void clearActualCondition(Element element)

### `addActualCondition`
public void addActualCondition(Element element, Element value)

### `removeActualCondition`
public void removeActualCondition(Element element, Element value)

### `getActualCondition`
public List<Element> getActualCondition(Element element)

### `setMilestone`
public void setMilestone(Element element, @CheckForNull Collection<? extends Element> value)

### `clearMilestone`
public void clearMilestone(Element element)

### `addMilestone`
public void addMilestone(Element element, Element value)

### `removeMilestone`
public void removeMilestone(Element element, Element value)

### `getMilestone`
public List<Element> getMilestone(Element element)

### `setURI`
public void setURI(Element element, @CheckForNull String value)

### `clearURI`
public void clearURI(Element element)

### `getURI`
@CheckForNull public String getURI(Element element)

### `setConformsTo`
public void setConformsTo(Element element, @CheckForNull Collection<? extends Element> value)

### `clearConformsTo`
public void clearConformsTo(Element element)

### `addConformsTo`
public void addConformsTo(Element element, Element value)

### `removeConformsTo`
public void removeConformsTo(Element element, Element value)

### `getConformsTo`
public List<Element> getConformsTo(Element element)

### `setEndDate`
public void setEndDate(Element element, @CheckForNull Element value)

### `clearEndDate`
public void clearEndDate(Element element)

### `getEndDate`
@CheckForNull public Element getEndDate(Element element)

### `setStartDate`
public void setStartDate(Element element, @CheckForNull Element value)

### `clearStartDate`
public void clearStartDate(Element element)

### `getStartDate`
@CheckForNull public Element getStartDate(Element element)

### `clear`
protected void clear()

### `is`
public boolean is(@CheckForNull Element element)

### `isInstance`
public static boolean isInstance(@CheckForNull Element element)
```

--------------------------------

### init (String, long)

Source: https://jdocs.nomagic.com/2026x/com/nomagic/task/SimpleProgressStatus.html

Initializes the progress status with a description and maximum value.

```APIDOC
## init

### Description
Initialize progress.

### Method
public void

### Parameters
#### Path Parameters
- **description** (String) - Required - progress description.
- **max** (long) - Required - maximum value.

### Response
#### Success Response
void

```

--------------------------------

### init

Source: https://jdocs.nomagic.com/2026x/com/nomagic/task/SimpleProgressStatus.html

Initializes the progress status with a description, minimum, maximum, and current values.

```APIDOC
## init

### Description
Initialize progress.

### Method
public void

### Parameters
#### Path Parameters
- **description** (String) - Required - progress description.
- **min** (long) - Required - minimum value.
- **max** (long) - Required - maximum value.
- **cur** (long) - Required - current value.

### Response
#### Success Response
void

```

--------------------------------

### getOutputDir

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/tests/common/TestEnvironment.html

Gets the default directory for a specific test case's output. The output directory is created if it does not already exist. It is located either in the parent directory (if specified by the 'tests.output' system property) or the MagicDraw installation root.

```APIDOC
## getOutputDir

### Description
Get default directory for specific test case output. Output directory is created if it does not exist. Output directory is located in parent directory if specified by "tests.output" system property or MagicDraw install root otherwise.

### Method
```java
public static File getOutputDir(Class clazz)
```

### Parameters
#### Path Parameters
- **clazz** (Class) - Description: Test case class to get output directory for.

### Returns
- File: representing output directory for test case.
```

--------------------------------

### UserTaskStereotype Properties

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.UserTaskStereotype.html

Provides methods to get and set properties related to the UserTaskStereotype, such as actual owner, implementation, renderings, task priority, boundary event references, completion quantity, default flow, IO specification, compensation status, resources, start quantity, state, and ID.

```APIDOC
## UserTaskStereotype Methods

### Description
Methods for managing properties of a UserTaskStereotype.

### Methods
- `getIsForCompensationProperty()`: Returns the property for checking if the task is for compensation.
- `getResourcesProperty()`: Returns the property for managing associated resources.
- `getStartQuantityProperty()`: Returns the property for the start quantity.
- `getStateProperty()`: Returns the property for the activity state.
- `getIdProperty()`: Returns the property for the element ID.
- `setActualOwner(Element element, String value)`: Sets the actual owner of the element.
- `clearActualOwner(Element element)`: Clears the actual owner of the element.
- `getActualOwner(Element element)`: Gets the actual owner of the element.
- `setImplementation(Element element, String value)`: Sets the implementation of the element.
- `clearImplementation(Element element)`: Clears the implementation of the element.
- `getImplementation(Element element)`: Gets the implementation of the element.
- `setRenderings(Element element, Collection<? extends Element> value)`: Sets the renderings for the element.
- `clearRenderings(Element element)`: Clears the renderings for the element.
- `addRenderings(Element element, Element value)`: Adds a rendering to the element.
- `removeRenderings(Element element, Element value)`: Removes a rendering from the element.
- `getRenderings(Element element)`: Gets the list of renderings for the element.
- `setTaskPriority(Element element, Integer value)`: Sets the task priority.
- `clearTaskPriority(Element element)`: Clears the task priority.
- `getTaskPriority(Element element)`: Gets the task priority.
- `setBoundaryEventRefs(Element element, Collection<? extends Element> value)`: Sets the boundary event references.
- `clearBoundaryEventRefs(Element element)`: Clears the boundary event references.
- `addBoundaryEventRefs(Element element, Element value)`: Adds a boundary event reference.
- `removeBoundaryEventRefs(Element element, Element value)`: Removes a boundary event reference.
- `getBoundaryEventRefs(Element element)`: Gets the list of boundary event references.
- `setCompletionQuantity(Element element, Integer value)`: Sets the completion quantity.
- `clearCompletionQuantity(Element element)`: Clears the completion quantity.
- `getCompletionQuantity(Element element)`: Gets the completion quantity.
- `setDefault(Element element, Element value)`: Sets the default flow element.
- `clearDefault(Element element)`: Clears the default flow element.
- `getDefault(Element element)`: Gets the default flow element.
- `setIoSpecification(Element element, Element value)`: Sets the IO specification.
- `clearIoSpecification(Element element)`: Clears the IO specification.
- `getIoSpecification(Element element)`: Gets the IO specification.
- `setIsForCompensation(Element element, Boolean value)`: Sets whether the task is for compensation.
- `clearIsForCompensation(Element element)`: Clears the compensation status.
- `isIsForCompensation(Element element)`: Checks if the task is for compensation.
- `setResources(Element element, Collection<? extends Element> value)`: Sets the resources for the element.
- `clearResources(Element element)`: Clears the resources for the element.
- `addResources(Element element, Element value)`: Adds a resource to the element.
- `removeResources(Element element, Element value)`: Removes a resource from the element.
- `getResources(Element element)`: Gets the list of resources for the element.
- `setStartQuantity(Element element, Integer value)`: Sets the start quantity.
- `clearStartQuantity(Element element)`: Clears the start quantity.
- `getStartQuantity(Element element)`: Gets the start quantity.
- `setState(Element element, BPMN2Profile.Activity_StateEnum value)`: Sets the activity state.
- `clearState(Element element)`: Clears the activity state.
- `getState(Element element)`: Gets the activity state.
- `setId(Element element, String value)`: Sets the ID of the element.
- `clearId(Element element)`: Clears the ID of the element.
- `getId(Element element)`: Gets the ID of the element.

### Utility Methods
- `clear()`: Protected method to clear internal state.
- `is(Element element)`: Checks if the given element is of this type.
- `isInstance(Element element)`: Static method to check if an element is an instance of this type.
```

--------------------------------

### Create New Project

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/core/project/ProjectsManager.html

Creates a new, empty project.

```java
public Project createProject()
```

--------------------------------

### get

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/esi/EsiUtils.html

Gets an instance of EsiUtils from the active session.

```APIDOC
## get (active session)

### Description
Retrieves an instance of `EsiUtils` from the currently active session.

### Method
`static`

### Signature
`EsiUtils get()`

### Returns
An instance of `EsiUtils`.
```

--------------------------------

### Layout Diagram with Custom Layouter and Options

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/uml/symbols/layout/Layouting.html

This example demonstrates how to layout a diagram using a specific layouter and customize its behavior with options. It shows how to retrieve, modify, and apply layouter options, such as setting the orientation for a hierarchic layout, and then restoring the original settings.

```java
AbstractDiagramPresentationElement diagram  = ...; // Diagram to layout
diagram.open()
//modify the environment options
HierarchicLayouterOptionsGroup optionsGroup = (HierarchicLayouterOptionsGroup) Application.getInstance().getEnvironmentOptions().getGroup(HierarchicLayouterOptionsGroup.ID);
String orientationBefore = optionsGroup.getOrientation();
optionsGroup.setOrientation(OrientationOptions.LEFT_TO_RIGHT);

Layouting.layout(diagram, Layouting.HIERARCHIC_DIAGRAM_LAYOUTER, optionsGroup);
//set orientation back
optionsGroup.setOrientation(orientationBefore);

```

--------------------------------

### Condition Get Method

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.ParallelMultipleCatchIntermediateEventStereotype.html

Gets the condition of an element.

```APIDOC
## getCondition

### Description
Gets the condition for a given element.

### Method
@CheckForNull public String getCondition(Element element)
```

--------------------------------

### Application.isTryToLoadProject()

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/core/Application.html

Checks if loading a project on startup is permitted.

```APIDOC
## Application.isTryToLoadProject()

### Description
Checks whether the application is configured to attempt loading a project file when it starts up. This is often determined by command-line arguments or configuration settings.

### Method
GET

### Endpoint
N/A (SDK method)

### Parameters
None

### Response
#### Success Response (200)
- **boolean** - True if project loading on startup is allowed, false otherwise.

### Response Example
```json
{
  "example": true
}
```
```

--------------------------------

### Clear GUID

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/sysml/util/MDCustomizationForSysMLProfile.FmuStereotype.html

Clears the GUID for a given element.

```APIDOC
## clearGUID

### Description
Clears the GUID for the specified element.

### Method
DELETE

### Endpoint
N/A (Java method)

### Parameters
#### Path Parameters
- **element** (Element) - Required - The element to clear the GUID from.
```

--------------------------------

### Set GUID

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/sysml/util/MDCustomizationForSysMLProfile.FmuStereotype.html

Sets the GUID for a given element.

```APIDOC
## setGUID

### Description
Sets the GUID for the specified element.

### Method
POST

### Endpoint
N/A (Java method)

### Parameters
#### Path Parameters
- **element** (Element) - Required - The element to set the GUID on.

#### Query Parameters
- **value** (String) - Required - The GUID value to set.
```

--------------------------------

### ProjectPartListenerAdapter Constructor

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/core/project/ProjectPartListenerAdapter.html

Initializes a new instance of the ProjectPartListenerAdapter class.

```APIDOC
## ProjectPartListenerAdapter()

### Description
Initializes a new instance of the ProjectPartListenerAdapter class.

### Constructor
`ProjectPartListenerAdapter()`
```

--------------------------------

### Help.getInstance()

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/help/Help.html

Retrieves the singleton instance of the Help utility class. This method should be called to get an instance before invoking other help-related methods.

```APIDOC
## Help.getInstance()

### Description
Singleton method to return an instance of the Help utility.

### Method
`static Help`

### Returns
- `Help` - The singleton help instance.
```

--------------------------------

### Error Reference Get Method

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.ParallelMultipleCatchIntermediateEventStereotype.html

Gets the error reference of an element.

```APIDOC
## getErrorRef

### Description
Gets the error reference for a given element.

### Method
@CheckForNull public Element getErrorRef(Element element)
```

--------------------------------

### ProjectCommandLine Constructor

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/commandline/ProjectCommandLine.html

Initializes a new instance of the ProjectCommandLine class.

```APIDOC
## ProjectCommandLine()

### Description
Initializes a new instance of the ProjectCommandLine class.

### Constructor
`ProjectCommandLine()`
```

--------------------------------

### GUID Property

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/sysml/util/MDCustomizationForSysMLProfile.FmuStereotype.html

Provides access to the GUID property of an FMU stereotype.

```APIDOC
## getGUIDProperty

### Description
Retrieves the Property object representing the GUID.

### Method
GET

### Endpoint
N/A (Java method)

### Returns
Property - The Property object for GUID.
```

--------------------------------

### initSingle

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/ui/dialogs/selection/ElementSelectionDlgFactory.html

Initializes the dialog for single element selection mode.

```APIDOC
## initSingle

### Description
Initializes the given dialog with a "single element" selection mode, allowing only one element to be selected.

### Method
public static void initSingle(ElementSelectionDlg dlg, SelectElementTypes types, SelectElementInfo info, @CheckForNull Object selection)

### Parameters
* `dlg` (ElementSelectionDlg) - Required - The dialog to initialize.
* `types` (SelectElementTypes) - Required - Information about the element selection types.
* `info` (SelectElementInfo) - Required - Settings for the dialog.
* `selection` (Object) - Optional - The initially selected element.

---

## initSingle

### Description
Initializes the given dialog with a "single element" selection mode, allowing only one element to be selected. This overload includes filters for visible and selectable elements, creatable types, and an option for whether the dialog is used as a type.

### Method
public static void initSingle(ElementSelectionDlg dlg, SelectElementInfo info, TypeFilter visibleElementsFilter, TypeFilter selectableElementsFilter, @CheckForNull Collection<?> creatableTypes, @CheckForNull Object selection)

### Parameters
* `dlg` (ElementSelectionDlg) - Required - The dialog to initialize.
* `info` (SelectElementInfo) - Required - Settings for the dialog.
* `visibleElementsFilter` (TypeFilter) - Required - Filter for visible elements in the dialog.
* `selectableElementsFilter` (TypeFilter) - Required - Filter for selectable elements in the dialog.
* `creatableTypes` (Collection) - Optional - Collection of creatable types (for Create button).
* `selection` (Object) - Optional - The initially selected element.

---

## initSingle

### Description
Initializes the given dialog with a "single element" selection mode, allowing only one element to be selected. This overload is similar to the previous one but includes a boolean flag indicating if the dialog is used as a type.

### Method
public static void initSingle(ElementSelectionDlg dlg, SelectElementInfo info, TypeFilter visibleElementsFilter, TypeFilter selectableElementsFilter, boolean usedAsType, @CheckForNull Collection<?> creatableTypes, @CheckForNull Object selection)

### Parameters
* `dlg` (ElementSelectionDlg) - Required - The dialog to initialize.
* `info` (SelectElementInfo) - Required - Settings for the dialog.
* `visibleElementsFilter` (TypeFilter) - Required - Filter for visible elements in the dialog.
* `selectableElementsFilter` (TypeFilter) - Required - Filter for selectable elements in the dialog.
* `usedAsType` (boolean) - Required - Flag indicating if the dialog is used as a type.
* `creatableTypes` (Collection) - Optional - Collection of creatable types (for Create button).
* `selection` (Object) - Optional - The initially selected element.
```

--------------------------------

### Constructor

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/magicreport/tools/ProjectModuleHelper.html

Initializes a new instance of the ProjectModuleHelper class.

```APIDOC
## Constructor ProjectModuleHelper

### Description
Initializes a new instance of the ProjectModuleHelper class.

### Method
public ProjectModuleHelper()

```

--------------------------------

### get (specific project)

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/esi/EsiUtils.html

Gets an instance of EsiUtils for a provided project session.

```APIDOC
## get (specific project)

### Description
Retrieves an instance of `EsiUtils` associated with a specific project session.

### Method
`static`

### Signature
`EsiUtils get(com.nomagic.ci.persistence.IPrimaryProject primary)`

### Parameters
* **primary** (com.nomagic.ci.persistence.IPrimaryProject) - The primary project session to associate with the `EsiUtils` instance.
```

--------------------------------

### createPackage

Source: https://jdocs.nomagic.com/2026x/com/nomagic/uml2/ext/magicdraw/metadata/UMLFactory.html

Returns a new object of class '_Output Pin_ '.

```APIDOC
## createPackage

### Description
Returns a new object of class '_Output Pin_ '.

### Method
Not applicable (SDK method)

### Endpoint
Not applicable (SDK method)

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **Output Pin** (object) - A new instance of the '_Output Pin_ ' class.
```

--------------------------------

### Other Install Actions Field in SwitchToPluginAction

Source: https://jdocs.nomagic.com/2026x/serialized-form.html

Serialized field for other installation actions in SwitchToPluginAction.

```Java
Collection<com.nomagic.magicdraw.rebranding.SwitchToPluginAction> mOtherInstallActions
```

--------------------------------

### Installation File Field in SwitchToPluginAction

Source: https://jdocs.nomagic.com/2026x/serialized-form.html

Serialized field for the installation file in SwitchToPluginAction.

```Java
File mInstallationFile
```

--------------------------------

### Create File from Template (No Context)

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicreport/engine/tools/FileTool.html

A shortcut to create a file where the output filename is the same as the template name and no import context object is provided.

```java
public String create(String template) throws ParseErrorException
```

--------------------------------

### Create ActionInputPin (no arguments)

Source: https://jdocs.nomagic.com/2026x/com/nomagic/uml2/ext/magicdraw/actions/mdstructuredactions/ActionInputPinClass.html

Creates a new ActionInputPin instance with default settings.

```APIDOC
## createActionInputPin

### Description
Creates a new ActionInputPin instance with default settings.

### Method
[Method Signature]
ActionInputPin createActionInputPin()

### Throws
`javax.jmi.reflect.JmiException`
```

--------------------------------

### Get Repository

Source: https://jdocs.nomagic.com/2026x/com/nomagic/uml2/ext/jmi/reflect/AbstractRefBaseObject.html

Gets the repository. This method is specified by the RepositoryProvider interface and implemented by AbstractRefBaseObject.

```Java
AbstractRepository getRepository()
```

--------------------------------

### init Method

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/validation/DefaultValidationRuleImpl.html

Initializes the validation rule instance with a project and a constraint.

```APIDOC
## init(Project project, Constraint constraint)

### Description
Initializes the instance from specified parameters.

### Method
`void init(Project project, Constraint constraint)`

### Parameters
#### Path Parameters
* None

#### Query Parameters
* None

#### Request Body
* None

### Parameters
* `project` (Project) - Required - Project on which model elements the validation rule applies.
* `constraint` (Constraint) - Required - A constraint object.
```

--------------------------------

### Start Quantity Management

Source: https://jdocs.nomagic.com/2026x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.AdHocSubProcessStereotype.html

Methods for setting and clearing the start quantity of an AdHocSubProcessStereotype element.

```APIDOC
## Start Quantity Management

### Description
Methods to manage the start quantity property of an AdHocSubProcessStereotype element.

### Methods

#### `setStartQuantity`
* **Description**: Sets the start quantity for the given element.
* **Parameters**:
  * `element` (Element) - The element to set the start quantity for.
  * `value` (Integer) - The start quantity value.

#### `clearStartQuantity`
* **Description**: Clears the start quantity for the given element.
* **Parameters**:
  * `element` (Element) - The element whose start quantity is to be cleared.

#### `getStartQuantity`
* **Description**: Retrieves the start quantity for the given element.
* **Parameters**:
  * `element` (Element) - The element to retrieve the start quantity from.
* **Returns**: An `Integer` representing the start quantity, or null if not set.
```
Tokens:
Raw