Chat now with support
Chat with Support

Identity Manager 9.2 - API Development Guide

run-apiserver

Starts or stops a local self-hosted API Server.

This command requires a database connection.

Parameters

Login parameter:

  • /conn <database connection>: Specifies the database you want 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.ServiceClientFactory, QBM.AppServer.Client

  • -S: Stops the API Server.

  • /baseaddress <base URL with port>: Specifies the base URL and port of the web application where the API Server accepts connections.

    Example

    /baseaddress http://localhost:8184
  • /baseurl <root URL>: Specifies the web application's URL.

    Example

    /baseaddress http://localhost
  • /plugin <file name 1, file name 2>: Loads additional plug-ins from the given files.

  • /htmldir <directory>: Specifies the directory to use to load additional HTML application files and plug-in. This setting is intended for development scenarios.

    Example

    /htmldir C:example\imxweb\cpl

    The cpl plug-in is loaded from the C:example\imxweb\cpl folder instead of the default source.

  • -T: Queries the status of the current API Server.

  • -B: Locks the console.

Related topics

start-update

Checks if software updates are available. If software updates are found, the software update starts.

Parameter

Login parameter:

  • /conn <database connection>: Specifies the database you want to connect to.

Optional parameter:

  • /target <update directory path>: Specifies the installation directory of the software to update. If you do not enter anything here, the current directory is used.

  • -C: Only checks if software updates are available. The software update does not start.

  • -G: Hides the software update user interface.

Related topics

workspace-info

Queries the state of the Angular working directory (existing applications and last API client update).

Parameters

Optional parameter:

  • /workspace: Specifies which working directory to query. If you do not enter anything here, the current directory is used.

Related topics
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating