Starts or stops a self-hosted API Server.
This command requires a database connection.
Parameters
Login parameters:
-
/conn <database connection>: Specifies the database to connect to.
-
/dialog <dialog authentication>: Specifies the dialog authentication.
Optional parameter:
-
/conndialog <option>: Specifies whether a login window is displayed for the database connection. The following options are possible:
-
off: The login window is not shown. If the database is not connected, an attempt is made to establish a connection.
-
show: The login window is shown (even is a database is already connected) and the new connection replaces the old one.
-
fallback (default): The current database connection is used. If the database is not connected, an attempt is made to establish a connection.
-
-
/factory <target system>: Specifies the target system for the connection. Enter this parameter if you want to establish a connection to the application server. Example: QBM.AppServer.Client.
-
-S: Stops the API Server.
-
/baseaddress <URL with port>: Specifies the web application's root URL and port.
-
/baseurl <root URL>: Specifies the web application's URL.
-
/branch <compilation branch ID>: Specifies the compilation branch with the API you want to start the API Server for.
-
/asmdir <filepath>: Loads the ZIP files containing the API DLLs and HTML files from the specified directory.
-
/apidll <filename>: Loads the API from the specified file instead of the database.
-
-D: Loads debug assemblies.
-
-C: Compiles the API with source data from the database.
-
-T: Queries the status of the current API Server.
-
-B: Locks the console.
-
/compile <solution file path>: Compiles the API with source data from the given (local) solution project.
-
/excludedMiddlewares <middleware name1, middleware name2, ...>: Specifies which middleware services are not be made available. Enter multiple values separated by a comma.