### setStartQuantity Methods Source: https://jdocs.nomagic.com/2024x/index-files/index-19.html Methods for setting the start quantity for various BPMN2 profile elements. ```APIDOC ## setStartQuantity(Element, Integer) ### Description Sets the start quantity for various task and subprocess types within the BPMN2 profile. ### Method Not applicable (Java method signature) ### Endpoint Not applicable (Java method signature) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) None #### Response Example None ``` -------------------------------- ### setStartTime Method Source: https://jdocs.nomagic.com/2024x/index-files/index-19.html Method for setting the start time within the SimulationConfigStereotype. ```APIDOC ## setStartTime(Element, Integer) ### Description Sets the start time for a simulation configuration. ### Method Not applicable (Java method signature) ### Endpoint Not applicable (Java method signature) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) None #### Response Example None ``` -------------------------------- ### Application Startup API Source: https://jdocs.nomagic.com/2024x/index-files/index-19.html APIs for starting the MagicDraw application with different configurations. ```APIDOC ## Application Startup ### `Application` Class #### Method: `start(String[])` - **Description**: Starts the application with an array of arguments. - **Method**: `start(String[])` - **Endpoint**: N/A (Java Method) #### Method: `start(boolean, boolean, boolean, String[], StartupParticipant)` - **Description**: Starts the application with detailed configuration options. - **Method**: `start(boolean, boolean, boolean, String[], StartupParticipant)` - **Endpoint**: N/A (Java Method) ``` -------------------------------- ### start (with args) Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/core/Application.html Starts the MagicDraw application with command line arguments. ```APIDOC ## start(String[] args) ### Description Starts the application. ### Method POST ### Endpoint /api/application/start ### Parameters #### Request Body - **args** (array of strings) - Optional - Command line arguments passed to MagicDraw. ### Request Example { "args": ["--open", "project.mdzip"] } ### Response #### Success Response (200) - **status** (string) - Indicates the application has started. ### Response Example { "status": "Application started successfully" } ### Error Handling - **ApplicationExitedException**: Thrown if the application exits during startup. ``` -------------------------------- ### Get Scenario Start Node Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/usecasescenarios/scenarios/Scenario.html Retrieves the node that starts the scenario. ```APIDOC ## GET /api/scenario/start ### Description Gets scenario node which starts scenario. ### Method GET ### Endpoint /api/scenario/start ### Response #### Success Response (200) - **startNode** (ScenarioNodeStart) - The node that starts the scenario. #### Response Example ```json { "startNode": { "id": "startNode1", "type": "Start" } } ``` ``` -------------------------------- ### start (with options) Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/core/Application.html Starts the MagicDraw application with various configuration options. ```APIDOC ## start(boolean visible, boolean silentMode, boolean tryToLoadProject, String[] args, @CheckForNull StartupParticipant participant) ### Description Starts the application. ### Method POST ### Endpoint /api/application/startWithOptions ### Parameters #### Request Body - **visible** (boolean) - Required - Start MagicDraw as a visible frame? - **silentMode** (boolean) - Required - True if GUI must be in silent mode (batch mode). - **tryToLoadProject** (boolean) - Required - True if application should try to load file passed as argument. - **args** (array of strings) - Optional - Command line arguments passed to MagicDraw. - **participant** (StartupParticipant) - Optional - The participant of the startup process. May be null. ### Request Example { "visible": true, "silentMode": false, "tryToLoadProject": true, "args": [], "participant": null } ### Response #### Success Response (200) - **status** (string) - Indicates the application has started. ### Response Example { "status": "Application started successfully" } ### Error Handling - **ApplicationExitedException**: Thrown if the application exits during the startup. ``` -------------------------------- ### Get Error Start Event Stereotype Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.html Deprecated method to get the Error Start Event stereotype. Use `getInstance(element).errorStartEvent().getStereotype()` instead. The Error Start Event is only allowed for triggering an in-line Event Sub-Process. ```java @Deprecated public Stereotype getErrorStartEvent() Deprecated. use getInstance(element).errorStartEvent().getStereotype() ``` -------------------------------- ### Get Start Boundary Type Source: https://jdocs.nomagic.com/2024x/com/nomagic/updm/utils/UPDMProfile.ServiceInterfaceStereotype.html Retrieves the start boundary type of an element. ```APIDOC ## GET /elements/{elementId}/startBoundaryType ### Description Retrieves the start boundary type of a given element. ### Method GET ### Endpoint /elements/{elementId}/startBoundaryType ### Parameters #### Path Parameters - **elementId** (string) - Required - The ID of the element whose start boundary type is to be retrieved. ### Response #### Success Response (200) - **startBoundaryType** (Element) - The element representing the start boundary type, or null if not set. #### Response Example { "startBoundaryType": { "id": "boundary1", "name": "Boundary Type 1" } } ``` -------------------------------- ### Main Class API Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/Main.html Documentation for the Main application startup class. ```APIDOC ## Main Class ### Description Application startup class. ### Constructor #### Main ```java public Main() ``` ### Methods #### main ```java public static void main(String[] arg) ``` ##### Description Application main startup method. ##### Parameters - **arg** (String[]) - Required - application arguments. ``` -------------------------------- ### Start Quantity Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.BusinessRuleTaskStereotype.html Methods for setting, clearing, and getting the start quantity of an element. ```APIDOC ## POST /api/elements/{elementId}/startQuantity ### Description Sets the start quantity for a given element. ### Method POST ### Endpoint /api/elements/{elementId}/startQuantity ### Parameters #### Path Parameters - **elementId** (string) - Required - The ID of the element. #### Request Body - **value** (Integer) - Optional - The start quantity to set. ### Response #### Success Response (200) - **message** (string) - Confirmation message. ``` ```APIDOC ## DELETE /api/elements/{elementId}/startQuantity ### Description Clears the start quantity for a given element. ### Method DELETE ### Endpoint /api/elements/{elementId}/startQuantity ### Parameters #### Path Parameters - **elementId** (string) - Required - The ID of the element. ### Response #### Success Response (200) - **message** (string) - Confirmation message. ``` ```APIDOC ## GET /api/elements/{elementId}/startQuantity ### Description Retrieves the start quantity of a given element. ### Method GET ### Endpoint /api/elements/{elementId}/startQuantity ### Parameters #### Path Parameters - **elementId** (string) - Required - The ID of the element. ### Response #### Success Response (200) - **startQuantity** (Integer) - The start quantity of the element. ``` -------------------------------- ### setStartWebServer Method Source: https://jdocs.nomagic.com/2024x/index-files/index-19.html Method for controlling the web server startup within the SimulationConfigStereotype. ```APIDOC ## setStartWebServer(Element, Boolean) ### Description Controls whether the web server should start for a simulation configuration. ### Method Not applicable (Java method signature) ### Endpoint Not applicable (Java method signature) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) None #### Response Example None ``` -------------------------------- ### StartupParticipant beforeMainWindow Method Source: https://jdocs.nomagic.com/2024x/index-files/index-2.html Callback for startup participants before the main application window is created. ```APIDOC ## StartupParticipant beforeMainWindow Method ### Description Is called before creating the main application window. ### Method `beforeMainWindow()` * **Interface**: `com.nomagic.magicdraw.core.StartupParticipant` ``` -------------------------------- ### Get Start Event Stereotype Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.html Retrieves the stereotype for a start event. This method is deprecated. ```java use getInstance(element).startEvent().getStereotype() ``` -------------------------------- ### ProjectOptions Method Source: https://jdocs.nomagic.com/2024x/index-files/index-19.html Method to get a project option setting. ```APIDOC ## Method in com.nomagic.magicdraw.core.options.ProjectOptions ### Description Retrieves the setting for displaying dot notation for associations. ### Method - **showDotNotationForAssociations()** - Gets the SHOW_DOT_NOTATION_FOR_ASSOCIATIONS property value. ``` -------------------------------- ### Execution Specification - Start Time Source: https://jdocs.nomagic.com/2024x/com/nomagic/uml2/ext/magicdraw/interactions/mdbasicinteractions/ExecutionSpecification.html Provides methods to get and set the start OccurrenceSpecification for an ExecutionSpecification. ```APIDOC ## GET /api/execution-specifications/{id}/start ### Description Retrieves the OccurrenceSpecification that designates the start of the Action or Behavior. ### Method GET ### Endpoint /api/execution-specifications/{id}/start ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the ExecutionSpecification. ### Response #### Success Response (200) - **startOccurrence** (OccurrenceSpecification) - The OccurrenceSpecification marking the start. #### Response Example ```json { "startOccurrence": { "id": "occ_spec_123", "name": "StartEvent" } } ``` ``` ```APIDOC ## PUT /api/execution-specifications/{id}/start ### Description Sets the OccurrenceSpecification that designates the start of the Action or Behavior. ### Method PUT ### Endpoint /api/execution-specifications/{id}/start ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the ExecutionSpecification. #### Request Body - **startOccurrenceId** (string) - Required - The ID of the OccurrenceSpecification to set as the start. ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example ```json { "message": "Start occurrence set successfully." } ``` ``` -------------------------------- ### StartupParticipant Methods Source: https://jdocs.nomagic.com/2024x/index-files/index-1.html Information about the afterMainWindow method for the StartupParticipant interface. ```APIDOC ## afterMainWindow() - StartupParticipant ### Description Is called after main application window creation. ### Method public void afterMainWindow() ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### setStartDate Methods Source: https://jdocs.nomagic.com/2024x/index-files/index-19.html Methods for setting the start date of various entities across UAF and UPDM profiles. ```APIDOC ## setStartDate(Element, Element) ### Description Sets the start date for various entities within UAF and UPDM profiles. ### Method Not applicable (Java method signature) ### Endpoint Not applicable (Java method signature) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) None #### Response Example None ``` -------------------------------- ### Example Usage of RunnableWithProgress Source: https://jdocs.nomagic.com/2024x/com/nomagic/task/RunnableWithProgress.html Demonstrates how to create an instance of `RunnableWithProgress`, implement the `run` method to perform a task with progress reporting, and then execute it using `ProgressStatusRunner.runWithProgressStatus`. ```APIDOC ## Example Usage of RunnableWithProgress ### Description This example shows how to implement and run a `RunnableWithProgress` task. ### Code Example ```java // create runnable RunnableWithProgress runnable = new RunnableWithProgress() { @Override public void run(ProgressStatus progressStatus) { int max = Integer.MAX_VALUE; progressStatus.init("Counting...", 0, max); for (int i = 0; i < max; ++i) { if (progressStatus.isCancel()) { // cancel clicked return; } progressStatus.increase(); } } }; // run with progress ProgressStatusRunner.runWithProgressStatus(runnable, "My progress", true, 0); ``` ### Method Call `ProgressStatusRunner.runWithProgressStatus(RunnableWithProgress runnable, String title, boolean canCancel, int delayMillis)` #### Parameters - **runnable** (`RunnableWithProgress`) - Required - The task to execute. - **title** (`String`) - Required - The title for the progress display. - **canCancel** (`boolean`) - Required - Whether the task can be cancelled by the user. - **delayMillis** (`int`) - Required - Delay in milliseconds before showing the progress. ``` -------------------------------- ### Get Start Boundary Type of Element Source: https://jdocs.nomagic.com/2024x/com/nomagic/updm/utils/UPDMProfile.ActualOrganizationalResourceStereotype.html Retrieves the start boundary type of a given Element. Returns null if no start boundary type is set. ```java @CheckForNull public Element getStartBoundaryType(Element element) ``` -------------------------------- ### Plugin Directory Management Source: https://jdocs.nomagic.com/2024x/index-files/index-19.html Methods for setting the plugin installation directory. ```APIDOC ## setPluginDirectory(File) ### Description Sets the plugin installation directory. ### Method `setPluginDirectory` ### Parameters #### Path Parameters - **file** (File) - Required - The directory where the plugin is installed. ### Request Example ```java // Example usage (assuming 'file' is a File object representing the directory) pluginDescriptor.setPluginDirectory(file); ``` ### Response No specific response details provided. ``` -------------------------------- ### Get Escalation Start Event Stereotype Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.html Deprecated method to get the Stereotype for an Escalation Start Event. Use `getInstance(element).escalationStartEvent().getStereotype()` instead. This event is only allowed for triggering an in-line Event Sub-Process. ```java @Deprecated public Stereotype getEscalationStartEvent() Deprecated. use getInstance(element).escalationStartEvent().getStereotype() ``` -------------------------------- ### init Method Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/dependencymatrix/datamodel/cell/DependencyExtractor.html Initializes the Dependency Extractor with current matrix settings and progress status. ```APIDOC ## void init(PersistenceManager settings, @CheckForNull ProgressStatus status) ### Description This method is called when matrix settings are changed and the whole matrix is being rebuilt. This way we can use it to update internal extractor settings according to new Dependency Matrix settings. ### Parameters - **settings** (PersistenceManager) - Required - current matrix settings - **status** (ProgressStatus) - Optional - progress status ``` -------------------------------- ### Get Timer Start Event Stereotype Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.html Retrieves the stereotype for a timer start event. This method is deprecated. ```java use getInstance(element).timerStartEvent().getStereotype() ``` -------------------------------- ### MountedPackageInfo Constructor Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/core/modules/MountedPackageInfo.html Initializes a new instance of the MountedPackageInfo class. ```APIDOC ## MountedPackageInfo Constructor ### Description Constructor for creating a new MountedPackageInfo object. ### Method CONSTRUCTOR ### Endpoint N/A ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ``` -------------------------------- ### Start Quantity Methods Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.ServiceTaskStereotype.html Methods for setting, clearing, and getting the start quantity of a BPMN 2.0 element. ```APIDOC ## POST /api/bpmn2/startQuantity ### Description Sets the start quantity for a BPMN 2.0 element. ### Method POST ### Endpoint /api/bpmn2/startQuantity ### Parameters #### Query Parameters - **element** (Element) - Required - The BPMN 2.0 element to set the start quantity for. - **value** (Integer) - Required - The start quantity value. ### Response #### Success Response (200) - **message** (string) - Indicates successful update. #### Response Example ```json { "message": "Start quantity set successfully." } ``` ## DELETE /api/bpmn2/startQuantity ### Description Clears the start quantity of a BPMN 2.0 element. ### Method DELETE ### Endpoint /api/bpmn2/startQuantity ### Parameters #### Query Parameters - **element** (Element) - Required - The BPMN 2.0 element to clear the start quantity from. ### Response #### Success Response (200) - **message** (string) - Indicates successful clear operation. #### Response Example ```json { "message": "Start quantity cleared successfully." } ``` ## GET /api/bpmn2/startQuantity ### Description Retrieves the start quantity of a BPMN 2.0 element. ### Method GET ### Endpoint /api/bpmn2/startQuantity ### Parameters #### Query Parameters - **element** (Element) - Required - The BPMN 2.0 element to get the start quantity from. ### Response #### Success Response (200) - **startQuantity** (Integer) - The start quantity. #### Response Example ```json { "startQuantity": 1 } ``` ``` -------------------------------- ### Application Startup Source: https://jdocs.nomagic.com/2024x/index-files/index-13.html Details on how to start the MagicDraw application. ```APIDOC ## Class: com.nomagic.magicdraw.Main ### Description Application startup class. ### Method `static void main(String[] args)` ### Description Application main startup method. ``` ```APIDOC ## Class: com.nomagic.magicdraw.Main ### Constructor `Main()` ``` -------------------------------- ### ExecutionEngine Method Details: init Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/simulation/engine/ExecutionEngine.html Details the `init` method for engine initialization. ```APIDOC ## Method: init ### Description Engine initialization. ### Parameters - **element** (`Element`) - the given element ``` -------------------------------- ### Start Quantity Methods Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.ReceiveTaskStereotype.html Methods for setting, clearing, and getting the start quantity of a BPMN 2.0 element. ```APIDOC ## Start Quantity Methods ### Description Methods for setting, clearing, and getting the start quantity of a BPMN 2.0 element. ### Methods - `setStartQuantity(Element element, Integer value)` - `clearStartQuantity(Element element)` - `getStartQuantity(Element element)` ### Parameters #### `setStartQuantity` and `clearStartQuantity` - **element** (Element) - The BPMN element. - **value** (Integer) - The start quantity value to set. #### `getStartQuantity` - **element** (Element) - The BPMN element. ### Request Example (setStartQuantity) ```json { "element": "", "value": 1 } ``` ### Response Example (getStartQuantity) ```json { "startQuantity": 1 } ``` ``` -------------------------------- ### Create New Project Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/core/project/ProjectsManager.html Initializes and returns a new, empty project. No parameters are required for this operation. ```java @OpenApi public Project createProject() ``` -------------------------------- ### Get Stereotype of Process Guides Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.html Use this method to retrieve the stereotype of process guides. This method is deprecated. ```javascript use getInstance(element).processGuides().getStereotype() ``` -------------------------------- ### Timer Start Event Stereotype Utilities Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.html Deprecated methods for checking and getting the Timer Start Event stereotype. ```APIDOC ## GET /api/bpmn/stereotype/timerStartEvent ### Description Retrieves the Stereotype for a Timer Start Event. This event triggers the start of a Process based on a specific time-date or cycle. ### Method GET ### Endpoint /api/bpmn/stereotype/timerStartEvent ### Parameters #### Query Parameters - **element** (Element) - Required - The BPMN element to check. ### Response #### Success Response (200) - **stereotype** (Stereotype) - The Stereotype object for the Timer Start Event. #### Response Example ```json { "stereotype": "timerStartEventStereotype" } ``` ## GET /api/bpmn/stereotype/isTimerStartEvent ### Description Checks if a given element is a Timer Start Event. ### Method GET ### Endpoint /api/bpmn/stereotype/isTimerStartEvent ### Parameters #### Query Parameters - **element** (Element) - Required - The BPMN element to check. ### Response #### Success Response (200) - **isInstance** (boolean) - True if the element is a Timer Start Event, false otherwise. #### Response Example ```json { "isInstance": true } ``` ``` -------------------------------- ### ProjectAbstractRepositoryInitializer Methods Source: https://jdocs.nomagic.com/2024x/com/nomagic/uml2/ext/jmi/reflect/ProjectAbstractRepositoryInitializer.html Details of the instance methods available in the ProjectAbstractRepositoryInitializer class. ```APIDOC ## ProjectAbstractRepositoryInitializer Methods ### getRepositoryType #### Description Returns the type of the repository associated with the project. #### Method `protected final Class getRepositoryType(P project)` #### Parameters - **project** (P) - Required - The project element. #### Response - **Class** - The repository type. ### createTransactionManager #### Description Creates a transaction manager for the given repository. #### Method `protected final com.dassault_systemes.modeler.foundation.transaction.TransactionManager createTransactionManager(AbstractRepository repository)` #### Parameters - **repository** (AbstractRepository) - Required - The repository for which to create a transaction manager. #### Response - **com.dassault_systemes.modeler.foundation.transaction.TransactionManager** - The created transaction manager. ``` -------------------------------- ### Get Conditional Start Event Stereotype Source: https://jdocs.nomagic.com/2024x/deprecated-list.html Use this to retrieve the stereotype for a Conditional Start Event. Ensure the BPMN2Profile is applied. ```java com.nomagic.magicdraw.cbm.profiles.BPMN2Profile.getConditionalStartEvent() use getInstance(element).conditionalStartEvent().getStereotype() ``` -------------------------------- ### ListProperty Constructor (no args) Source: https://jdocs.nomagic.com/2024x/index-files/index-12.html Creates and initializes a new `ListProperty` object. ```APIDOC ## ListProperty Constructor (no args) ### Description Creates and initializes a new `ListProperty` object. ### Method Constructor ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Application Constructor Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/core/Application.html Initializes a new instance of the Application class. ```APIDOC ## Application() ### Description Constructor of Application. ### Method CONSTRUCTOR ### Endpoint N/A ### Parameters None ### Request Example None ### Response None ### Response Example None ``` -------------------------------- ### Get Compensation Start Event Stereotype Source: https://jdocs.nomagic.com/2024x/deprecated-list.html Use this to retrieve the stereotype for a Compensation Start Event. Ensure the BPMN2Profile is applied. ```java com.nomagic.magicdraw.cbm.profiles.BPMN2Profile.getCompensationStartEvent() use getInstance(element).compensationStartEvent().getStereotype() ``` -------------------------------- ### Get Stereotype of Signal Start Event Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.html Use this method to retrieve the stereotype of a signal start event. This method is deprecated. ```javascript use getInstance(element).signalStartEvent().getStereotype() ``` -------------------------------- ### Start Application with Arguments Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/core/Application.html Starts the MagicDraw application with command-line arguments. Use this for basic application startup. ```java public void start(String[] args) throws ApplicationExitedException ``` -------------------------------- ### Get Stereotype of None Start Event Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.html Use this method to retrieve the stereotype of a none start event. This method is deprecated. ```javascript use getInstance(element).noneStartEvent().getStereotype() ``` -------------------------------- ### Main Method Source: https://jdocs.nomagic.com/2024x/com/nomagic/utils/Utilities.html The main entry point for the application. ```APIDOC ## Main Method ### Description Entry point for the application. ### Parameters - **args** (String[]) - Command line arguments. ``` -------------------------------- ### AbstractRefPackage Constructor Source: https://jdocs.nomagic.com/2024x/com/nomagic/uml2/ext/jmi/reflect/AbstractRefPackage.html Initializes an AbstractRefPackage with a given repository. ```APIDOC ## Constructor Details ### AbstractRefPackage ```java public AbstractRefPackage(@CheckForNull AbstractRepository repository) ``` #### Parameters * **repository** (AbstractRepository) - The repository to associate with this package. ``` -------------------------------- ### Start Object Behavior Action API Source: https://jdocs.nomagic.com/2024x/com/nomagic/uml2/ext/magicdraw/actions/mdbasicactions/InputPin.html Provides methods to set and get the start object behavior action associated with an object. ```APIDOC ## POST /api/object/startObjectBehaviorAction ### Description Sets the value of the '`_start Object Behavior Action Of Object_`' container reference. ### Method POST ### Endpoint /api/object/startObjectBehaviorAction ### Parameters #### Request Body - **value** (StartObjectBehaviorAction) - Required - The new value for the '_start Object Behavior Action Of Object_ ' container reference. ### Request Example ```json { "value": "some_start_object_behavior_action_value" } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation. #### Response Example ```json { "status": "success" } ``` ``` ```APIDOC ## GET /api/object/startObjectBehaviorAction ### Description Returns the value of the '_**start Object Behavior Action Of Object**_ ' container reference. It is bidirectional and its opposite is '`_Object_`'. ### Method GET ### Endpoint /api/object/startObjectBehaviorAction ### Response #### Success Response (200) - **value** (StartObjectBehaviorAction) - The current value of the '_start Object Behavior Action Of Object_ ' container reference. #### Response Example ```json { "value": "current_start_object_behavior_action_value" } ``` ``` -------------------------------- ### Create Start Object Behavior Action Source: https://jdocs.nomagic.com/2024x/com/nomagic/uml2/ext/magicdraw/metadata/UMLFactory.html Creates a new object of class '_Start Object Behavior Action_'. ```APIDOC ## createStartObjectBehaviorAction ### Description Returns a new object of class '_Start Object Behavior Action_'. ### Method POST ### Endpoint /api/createStartObjectBehaviorAction ### Request Body None ### Response #### Success Response (200) - **StartObjectBehaviorAction** (object) - A new object of class '_Start Object Behavior Action_'. ### Response Example ```json { "message": "StartObjectBehaviorAction created successfully", "data": {} } ``` ``` -------------------------------- ### Get Timer Start Event (True) Stereotype Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.html Retrieves the stereotype for a timer start event where the condition is true. This method is deprecated. ```java use getInstance(element).start_timer_true().getStereotype() ``` -------------------------------- ### Get Timer Start Event (False) Stereotype Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.html Retrieves the stereotype for a timer start event where the condition is false. This method is deprecated. ```java use getInstance(element).start_timer_false().getStereotype() ``` -------------------------------- ### ProjectWindow Constructor Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/ui/ProjectWindow.html Initializes a new instance of the ProjectWindow class. ```APIDOC ## ProjectWindow Constructor ### Description Constructor for the ProjectWindow class. ### Method `ProjectWindow(WindowComponentInfo info, WindowComponentContent content)` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) None #### Response Example None ``` -------------------------------- ### Get Signal Start Event (True) Stereotype Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.html Retrieves the stereotype for a signal start event where the condition is true. This method is deprecated. ```java use getInstance(element).start_signal_true().getStereotype() ``` -------------------------------- ### ListProperty Constructors Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/properties/ListProperty.html Details on how to create and initialize ListProperty objects. ```APIDOC ## Constructors ### ListProperty() Creates and initializes a new `ListProperty` object. ID of the property will be empty string and value - null. ### ListProperty(String id, Object[] value) Creates and initializes a new `ListProperty` object from specified parameters. Parameters: - **id** (String) - id of the property. - **value** (Object[]) - value of the property. ``` -------------------------------- ### Get Signal Start Event (False) Stereotype Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.html Retrieves the stereotype for a signal start event where the condition is false. This method is deprecated. ```java use getInstance(element).start_signal_false().getStereotype() ``` -------------------------------- ### Project Options Methods Source: https://jdocs.nomagic.com/2024x/index-files/index-19.html Methods for configuring project options, including QNAME display style. ```APIDOC ## setQNameDisplayStyle(String) ### Description Sets the QNAME_DISPLAY_STYLE property value for the project. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ``` ```APIDOC ## setQNameDisplayAbsolute(boolean) ### Description Deprecated. Use `ProjectOptions.setQNameDisplayStyle(String)` instead. ### Method N/A (Method Signature) ### Endpoint N/A ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ``` -------------------------------- ### Get Multiple Start Event (True) Stereotype Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.html Retrieves the stereotype for a multiple start event where the condition is true. This method is deprecated. ```java use getInstance(element).start_multiple_true().getStereotype() ``` -------------------------------- ### Create StartObjectBehaviorAction Instance Source: https://jdocs.nomagic.com/2024x/com/nomagic/uml2/impl/ElementsFactory.html Creates a new instance of StartObjectBehaviorAction. ```APIDOC ## POST /api/instances/startObjectBehaviorAction ### Description Creates a new instance of StartObjectBehaviorAction. ### Method POST ### Endpoint /api/instances/startObjectBehaviorAction ### Request Body This endpoint does not require a request body. ### Response #### Success Response (201) - **instance** (StartObjectBehaviorAction) - The newly created StartObjectBehaviorAction instance. #### Response Example ```json { "instance": { "@class": "StartObjectBehaviorAction", "id": "generated-id-141" } } ``` ``` -------------------------------- ### Get Multiple Start Event (False) Stereotype Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.html Retrieves the stereotype for a multiple start event where the condition is false. This method is deprecated. ```java use getInstance(element).start_multiple_false().getStereotype() ``` -------------------------------- ### StartObjectBehaviorAction Creation API Source: https://jdocs.nomagic.com/2024x/com/nomagic/uml2/ext/magicdraw/actions/mdcompleteactions/StartObjectBehaviorActionClass.html This section details the methods available for creating StartObjectBehaviorAction instances. ```APIDOC ## POST /api/startObjectBehaviorAction ### Description Creates a new StartObjectBehaviorAction instance. ### Method POST ### Endpoint /api/startObjectBehaviorAction ### Parameters #### Query Parameters - **isLeaf** (Boolean) - Optional - Specifies if the action is a leaf node. - **isLocallyReentrant** (Boolean) - Optional - Specifies if the action is locally reentrant. - **isSynchronous** (Boolean) - Optional - Specifies if the action is synchronous. - **name** (String) - Optional - The name of the action. - **visibility** (VisibilityKind) - Optional - The visibility kind of the action. ### Request Example ```json { "isLeaf": true, "isLocallyReentrant": false, "isSynchronous": true, "name": "MyAction", "visibility": "public" } ``` ### Response #### Success Response (200) - **StartObjectBehaviorAction** (object) - The created StartObjectBehaviorAction instance. #### Response Example ```json { "actionId": "123e4567-e89b-12d3-a456-426614174000" } ``` ## POST /api/startObjectBehaviorAction/simple ### Description Creates a basic StartObjectBehaviorAction instance without additional parameters. ### Method POST ### Endpoint /api/startObjectBehaviorAction/simple ### Request Example ```json { "message": "Creating a simple action" } ``` ### Response #### Success Response (200) - **StartObjectBehaviorAction** (object) - The created StartObjectBehaviorAction instance. #### Response Example ```json { "actionId": "a1b2c3d4-e5f6-7890-1234-567890abcdef" } ``` ``` -------------------------------- ### Get Message Start Event (True) Stereotype Source: https://jdocs.nomagic.com/2024x/com/nomagic/magicdraw/cbm/profiles/BPMN2Profile.html Retrieves the stereotype for a message start event where the condition is true. This method is deprecated. ```java use getInstance(element).start_message_true().getStereotype() ```