run-apiserver
Starts or stops a self-hosted API Server.
This command requires a database connection.
Parameters
Login parameters:
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.
-
-T: Queries the status of the current API Server.
-
-B: Locks the console.
Related topics
fetch-files
Loads a specific machine role from the database and saves it in a local folder.
Parameters
Login parameters:
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.
-
/workspace <working directory path>: Specifies the working directory where the files should be placed. If you do not enter anything here, the current directory is used.
-
/targets <target1;target2;...>: Specifies which machine roles you want to use.
Related topics
push-files
Saves files that you have changed locally back to the database.
Parameters
Login parameters:
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.
-
/targets <target1;target2;...>: Specifies which machine roles you want to use.
-
/workspace <folder path>: Specifies the working directory where the files are located that have been modified and are now to be stored in the database.
-
/tag <uid>: Specifies the UID of a change tag.
-
/add <file1;file2;...>: Specifies which new database files are added. Use relative paths.
-
/del <file1;file2;...>: Specifies which database files are deleted. Use relative paths.
-
-C: Prevents the saving of changed files and saves only new files, and deletes files from the database.
Related topics
get-apistate
Queries the compilation status of the API in the database.
Parameters
Login parameters:
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.
-
/branch <compilation branch ID>: Queries the compilation status of the API saved under this compilation branch.
-
/htmlapp <name of the HTML package>: Returns data for the specified HTML package.
-
-D: Returns data for debug assemblies.
-
-R: Returns data for release assemblies.
Related topics
