Operationen des Webdiensts
Der AE Internal Webservice war die frühere Methode für die Kommunikation mit einem AE-System. Sie wird nur für Partner unterstützt, die noch alte Installationen und Integrationen verwalten müssen. Für neue Installationen und Integrationen ist die REST-API die neuere und bevorzugte Kommunikationstechnologie. Weitere Informationen finden Sie unter REST-API
Eine Beschreibung der Operationen finden Sie auch in der mitgelieferten Datei uc4.wsdl.
Diese Seite beinhaltet Folgendes:
An- und Abmeldung
| Beschreibung | Operation | Parameter | Rückgabewert |
|---|---|---|---|
| Anmeldung | logon
| Mandant, Benutzername, Abteilung, Passwort, Sprache Zulässige Werte für die Sprache: 68 (Deutsch), 69 (Englisch) und 70 (Französisch) | Session-ID |
| Abmeldung | logoff | Session-ID | - |
Informationen zum AE-System
| Beschreibung | Operation | Parameter | Rückgabewert |
|---|---|---|---|
| Automation Engine-Version samt Hotfixnummer ermitteln | getVersion | - | Automation Engine Version Beispiel 8.00A909-001 |
| Datenbank-Informationen ermitteln | getDatabaseInfo | - | Typ namens DatabaseInformation Verwenden Sie diesen Typ, um die einzelnen Infos wie z. B. den Datenbanknamen abzufragen |
Informationen über Mandanten
Hinweis:Der System-Mandant 0 liefert Ihnen eine Liste über sämtliche Benutzer, Agenten usw. des AE-Systems. Wenn Sie sich an einen benutzerdefinierte Mandanten anmelden, erhalten Sie nur die Objekte des Mandanten. Die Liste entspricht dem Inhalt der Administration-Perspektive.
| Beschreibung | Operation | Parameter | Rückgabewert |
|---|---|---|---|
| Auflistung der Serverprozesse | getServerList | - | Auflistung vom Typ ServerListItem Verwenden Sie diesen Typ, um die einzelnen Infos wie z. B. den Namen des Serverprozesses abzufragen |
| Aufstellung über die Belastung der Serverprozesse | getSystemWorkload | - | Auflistung vom Typ WorkLoadItem Verwenden Sie diesen Typ, um die einzelnen Infos wie z. B. den Durchschnitt abzufragen |
| Auflistung der Mandanten | getClientList | - | Auflistung vom Typ ClientListItem Verwenden Sie diesen Typ, um die einzelnen Infos wie z. B. die Zeitzone abzufragen |
| Auflistung der Benutzer | getUserList | - | Auflistung vom Typ UserListItem Verwenden Sie diesen Typ, um die einzelnen Infos wie z. B. den Namen abzufragen |
| Auflistung der Agenten | getAgentList | - | Auflistung vom Typ AgentListItem Verwenden Sie diesen Typ, um die einzelnen Infos wie z. B. die Rollen abzufragen |
| Auflistung der Agentengruppen | getAgentGroupList | - | Auflistung vom Typ AgentGroupListItem Verwenden Sie diesen Typ, um die einzelnen Infos wie z. B. den Modus abzufragen |
| Inhalt des Process Monitoring. | getActivityList | Filter Der Parameter ist vom Typ TaskFilter | Auflistung vom Typ Task Verwenden Sie diesen Typ, um die einzelnene Aufgaben abzufragen |
| Oberste Priorität aus allen aktiven Benachrichtigung (CALL) | getHighestNotificationPriority | - | Höchste Priorität aus allen laufenden Benachrichtigungen. Mögliche Werte: LOW - Niedrig |
Mandanten starten und stoppen
| Beschreibung | Operation | Parameter | Rückgabewert |
|---|---|---|---|
| Mandant starten | resumeClient | - | - |
| Mandant stoppen | suspendClient | - | - |
Starten, beenden etc. Aufgaben
| Beschreibung | Operation | Parameter | Rückgabewert |
|---|---|---|---|
| Objekt starten | executeObject | Objektname, Zeitzone, Input-Parameter für READ-Masken, Startzeitpunkt, auf manuelle Freigabe warten Weitere Informationen finden Sie unter Ausfüllen: Lese-Masken in Nutzung des Webdiensts Der Parameter Auf manuelle Freigabe warten ist vom Typ Boolean. | RunID der gestarteten Aufgabe |
| Periodische Aufgabe starten | executeRecurring | Objektname, Zeitzone, Frequenz, Zeitfenster, Tage, Bereich Der Parameter Frequenz ist vom Typ ExecuteFrequency. Der Parameter Zeitfenster ist vom Typ ExecuteTimeFrame. Der Parameter Tage ist vom Typ ExecuteDays. Der Parameter Bereich ist vom Typ ExecuteRange. | RunID des gestarteten Perioden-Containers |
| Aufgabe wiederholen | restartTask | Referenz-RunID, Neustartpunkt, Starttyp beibehalten, auf manuelle Freigabe warten, Neustartnur für abgebrochene Child-Aufgaben Der 3., 4. und 5. Parameter ist vom Typ boolean. | - |
| Aufgabe stoppen | suspendTask | RunID, Rekursiv Der Parameter "Rekursiv" ist vom Typ boolean. | - |
| Gestoppte Aufgabe auf aktiv setzen | resumeTask | RunID, Rekursiv Der Parameter Rekursiv ist vom Typ Boolean. | - |
| Aufgabe beenden | quitTask | RunID | - |
| Aufgabe abbrechen | cancelTask | RunID, Rekursiv Der Parameter Rekursiv ist vom Typ Boolean. | - |
| Aufgabe deaktivieren | deactivateTask | RunID | - |
| Aufgabe übernehmen | adoptTask | RunID | - |
Aufgaben während ihrer Durchführung
| Beschreibung | Operation | Parameter | Rückgabewert |
|---|---|---|---|
| Schedule beim nächsten Periodenwechsel neu laden | setReloadNextTurnaround | Schedule-Name | - |
| Sync-Bedingungen ignorieren | ignoreTaskSyncCondition | RunID | - |
| Vormerkung aufheben | unregisterTask | RunID | - |
| Startzeitpunkt einer Aufgabe setzen | setTaskStartTime | RunID, Startzeitpunkt, Zeitzone | - |
| Status einer Aufgabe setzen | setTaskState | RunID, alter Status, neuer Status Geben Sie in beiden Status Parametern die System-Rückgabewerte von ausführbaren Objekten an. | - |
| Aufgabe sofort starten | startTaskImmediately | RunID | - |
| Info des Detailfensters der Aufgabe auslesen | getTaskDetails | RunID | Auflistung vom Typ DetailGroup Verwenden Sie den Typ, um die einzelnen Infos wie z. B. den Status abzufragen |
Workflow und Workflow-Aufgaben
| Beschreibung | Operation | Parameter | Rückgabewert |
|---|---|---|---|
| Setzen eines Haltepunktes in einem Workflow | setProcessFlowBreakPoint | RunID | - |
| Haltepunkt in einem Workflow entfernen | removeProcessFlowBreakPoint | RunID | - |
| Blockierung einer Aufgabe in einem Workflow aufheben | unblockProcessFlowTask | RunID | - |
| Aufgabe in einem Workflow auf aktiv setzen | setProcessFlowTaskActive | RunID | - |
| Aufgabe in einem Workflow auf inaktiv setzen | setProcessFlowTaskInactive | RunID | - |
Siehe auch: