Chat now with support
Chat mit Support

Identity Manager 8.2 - API Designer Benutzer-und Entwicklungshandbuch

Der API Designer Grundlagen der API-Entwicklung Beispiele und Hilfe – Software Development Kit Schnellstart – Eine API erstellen Arbeiten mit dem API Designer
API Designer starten Projekttypen Benutzeroberfläche Globale Einstellungen Datenbankobjekte Änderungen kennzeichnen Suchen und Ersetzen Mehrsprachige Texte Datenbankabfragen verwalten Tabreiter verwalten Layouts verwalten Änderungshistorie anzeigen (Befehlsliste) Lesezeichen API kompilieren Versionen verwalten (Kompilierungszweige) API testen C#-Projekte mit dem API Designer verbinden
API-Projekte API-Dateien API Server ImxClient-Kommandozeilenprogramm

run-apiserver

Startet oder stoppt einen "self-hosted" API Server.

Diese Kommando benötigt eine Datenbankverbindung.

Parameter

Anmeldeparameter:

  • /conn <Name der Datenbankverbindung>: Legt die Datenbank fest, auf die verbunden werden soll.

  • /dialog <Name der Dialog-Authentifikation>: Legt die Dialog-Authentifikation fest.

Optionale Parameter:

  • /conndialog <Option>: Legt fest, ob ein Anmeldedialog für die Datenbankverbindung angezeigt werden soll. Die folgenden Optionen sind möglich:

    • off: Es wird kein Anmeldedialog angezeigt. Wenn keine Verbindung zur Datenbank besteht, wird versucht eine Verbindung herzustellen.

    • show: Ein Anmeldedialog wird angezeigt (auch wenn bereits eine Verbindung zur Datenbank besteht) und die Verbindung wird durch die neue ersetzt.

    • fallback: (Standardwert) Wenn eine Verbindung zur Datenbank besteht, wird diese verwendet. Wenn keine Verbindung zur Datenbank besteht, wird versucht eine Verbindung herzustellen.

  • /factory <Name des Zielsystems>: Legt das Zielsystem für die Verbindung fest. Geben Sie diesen Parameter an, wenn Sie eine Verbindung zum Anwendungsserver aufbauen möchten. Beispiel: QBM.AppServer.Client

  • -S: Stoppt den API Server.

  • /baseaddress <URL mit Port-Angabe>: Legt die Basis-URL und den Port der Webanwendung fest.

  • /baseurl <Basis-URL>: Legt die Basis-URL der Webanwendung fest.

  • /branch <ID des Kompilierungszweiges>: Legt den Kompilierungszweig fest, für dessen API Sie den API Server starten möchten.

  • /asmdir <Dateipfad>: Lädt die ZIP-Dateien, die die API-DLLs und HTML-Dateien enthalten, aus dem angegebenen Verzeichnis.

  • /apidll <Dateiname>: Lädt die API aus der angegeben Datei anstatt aus der Datenbank.

  • -D: Lädt die Debugging-Assemblies.

  • -C: Kompiliert die API mit Quelldaten aus der Datenbank.

  • -T: Fragt den Status des laufenden API Servers ab.

  • -B: Sperrt die Konsole.

  • /compile <Pfad zur Solution-Datei>: Kompiliert die API mit Quelldaten aus dem angegebenen (lokalen) Solution-Projekt.

  • /excludedMiddlewares <Middleware-Name1,Middleware-Name2,...>: Legt fest, welche Middleware-Dienste nicht zur Verfügung gestellt werden sollen. Geben Sie mehrere Einträge kommasepariert an.

Verwandte Themen

fetch-files

Lädt alle Dateien der Maschinenrolle "HTML Development" aus der Datenbank und speichert sie in einem lokalen Ordner.

Parameter

Anmeldeparameter:

  • /conn <Name der Datenbankverbindung>: Legt die Datenbank fest, auf die verbunden werden soll.

  • /dialog <Name der Dialog-Authentifikation>: Legt die Dialog-Authentifikation fest.

Optionale Parameter:

  • /conndialog <Option>: Legt fest, ob ein Anmeldedialog für die Datenbankverbindung angezeigt werden soll. Die folgenden Optionen sind möglich:

    • off: Es wird kein Anmeldedialog angezeigt. Wenn keine Verbindung zur Datenbank besteht, wird versucht eine Verbindung herzustellen.

    • show: Ein Anmeldedialog wird angezeigt (auch wenn bereits eine Verbindung zur Datenbank besteht) und die Verbindung wird durch die neue ersetzt.

    • fallback: (Standardwert) Wenn eine Verbindung zur Datenbank besteht, wird diese verwendet. Wenn keine Verbindung zur Datenbank besteht, wird versucht eine Verbindung herzustellen.

  • /factory <Name des Zielsystems>: Legt das Zielsystem für die Verbindung fest. Geben Sie diesen Parameter an, wenn Sie eine Verbindung zum Anwendungsserver aufbauen möchten. Beispiel: QBM.AppServer.Client

  • /workspace <Pfad zum Arbeitsverzeichnis>: Legt das Arbeitsverzeichnis fest, in dem die Dateien abgelegt werden sollen. Wenn Sie hier nichts angeben, wird das aktuelle Verzeichnis verwendet.

  • /targets <Ziel1;Ziel2;...>: Legt fest, welche Maschinenrollen verwendet werden sollen. Wenn Sie hier nichts angeben, wird die Maschinenrolle HTML Development verwendet.

Verwandte Themen

push-files

Speichert Dateien, die Sie lokal geändert haben, wieder in der Datenbank.

Parameter

Anmeldeparameter:

  • /conn <Name der Datenbankverbindung>: Legt die Datenbank fest, auf die verbunden werden soll.

  • /dialog <Name der Dialog-Authentifikation>: Legt die Dialog-Authentifikation fest.

Optionale Parameter:

  • /conndialog <Option>: Legt fest, ob ein Anmeldedialog für die Datenbankverbindung angezeigt werden soll. Die folgenden Optionen sind möglich:

    • off: Es wird kein Anmeldedialog angezeigt. Wenn keine Verbindung zur Datenbank besteht, wird versucht eine Verbindung herzustellen.

    • show: Ein Anmeldedialog wird angezeigt (auch wenn bereits eine Verbindung zur Datenbank besteht) und die Verbindung wird durch die neue ersetzt.

    • fallback: (Standardwert) Wenn eine Verbindung zur Datenbank besteht, wird diese verwendet. Wenn keine Verbindung zur Datenbank besteht, wird versucht eine Verbindung herzustellen.

  • /factory <Name des Zielsystems>: Legt das Zielsystem für die Verbindung fest. Geben Sie diesen Parameter an, wenn Sie eine Verbindung zum Anwendungsserver aufbauen möchten. Beispiel: QBM.AppServer.Client

  • /targets <Ziel1;Ziel2;...>: Legt fest, welche Maschinenrollen verwendet werden sollen. Wenn Sie hier nichts angeben, wird die Maschinenrolle HTML Development verwendet.

  • /workspace <Pfad zum Ordner>: Legt das Arbeitsverzeichnis fest, in dem die Dateien liegen, die geändert wurden und jetzt in der Datenbank gespeichert werden sollen.

  • /tag <uid>: Legt die UID eines Change-Tags fest.

  • /add <Datei1;Datei2;...>: Legt fest, welche neuen Dateien der Datenbank hinzugefügt werden sollen. Verwenden Sie relative Pfade.

  • /del <Datei1;Datei2;...>: Legt fest, welche Dateien aus der Datenbank gelöscht werden sollen. Verwenden Sie relative Pfade.

  • -C: Verhindert das Speichern von geänderten Dateien und speichert nur neue Dateien und löscht Dateien in der Datenbank.

Verwandte Themen

get-apistate

Fragt den Kompilierungsstatus der API in der Datenbank ab.

Parameter

Anmeldeparameter:

  • /conn <Name der Datenbankverbindung>: Legt die Datenbank fest, auf die verbunden werden soll.

  • /dialog <Name der Dialog-Authentifikation>: Legt die Dialog-Authentifikation fest.

Optionale Parameter:

  • /conndialog <Option>: Legt fest, ob ein Anmeldedialog für die Datenbankverbindung angezeigt werden soll. Die folgenden Optionen sind möglich:

    • off: Es wird kein Anmeldedialog angezeigt. Wenn keine Verbindung zur Datenbank besteht, wird versucht eine Verbindung herzustellen.

    • show: Ein Anmeldedialog wird angezeigt (auch wenn bereits eine Verbindung zur Datenbank besteht) und die Verbindung wird durch die neue ersetzt.

    • fallback: (Standardwert) Wenn eine Verbindung zur Datenbank besteht, wird diese verwendet. Wenn keine Verbindung zur Datenbank besteht, wird versucht eine Verbindung herzustellen.

  • /factory <Name des Zielsystems>: Legt das Zielsystem für die Verbindung fest. Geben Sie diesen Parameter an, wenn Sie eine Verbindung zum Anwendungsserver aufbauen möchten. Beispiel: QBM.AppServer.Client

  • /branch <ID des Kompilierungszweiges>: Fragt den Kompilierungsstatus der API ab, die unter dem angegebenen Kompilierungszweig gespeichert wurde.

  • /htmlapp <Name des HTML-Pakets>: Liefert Daten für das angegebene HTML-Paket.

  • -D: Liefert Daten für Debug-Assemblies.

  • -R: Liefert Daten für Release-Assemblies.

Verwandte Themen
Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen