Anwendungsintegration > Internal Webservices > Operationen des Webservices

Operationen des Webservices

Eine Beschreibung der Operationen finden Sie auch in der mitgelieferten Datei uc4.wsdl.

An- und Abmeldung

Beschreibung Operation Parameter Rückgabewert
Anmeldung

logon

 

Mandant, Benutzername, Abteilung, Passwort, Sprache

Erlaubte Werte für die Sprache: "68" (Deutsche), "69" (Englisch) und "70" (Französisch)

Session-ID
Abmeldung logoff Session-ID -

Informationen zum Automation Engine System

Beschreibung Operation Parameter Rückgabewert
Automation Engine-Version samt Hotfixnummer ermitteln getVersion -

Automation Engine-Version

Beispiel: 8.00A909-001

Datenbank-Informationen ermitteln (siehe Systemübersicht - Datenbank) getDatabaseInfo -

Typ namens DatabaseInformation

Verwenden Sie diesen Typ, um die einzelnen Infos wie z.B: den Datenbanknamen abzufragen

Informationen über Mandanten

Der Systemmandant 0000 liefert Ihnen eine Liste über sämtliche Benutzer, Agenten etc. des Automation Engine Systems. Wenn Sie sich an einen benutzerdefinierte Mandanten anmelden, erhalten Sie nur die Objekte des Mandanten. Die Liste entspricht jener in der Systemübersicht.

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 Aktivitätenfensters getActivityList

Filter

Der Parameter ist vom Typ TaskFilter

Auflistung vom Typ Task

Verwenden Sie diesen Typ, um die einzelnene Aufgaben abzufragen

Höchste Priorität der aktiven Benachrichtigungen getHighestNotificationPriority -

Höchste Priorität aus allen laufenden Benachrichtigungen.

Mögliche Werte:

"LOW" - Niedrig
"MEDIUM" - Normal
"HIGH" - Hoch

Mandanten starten und stoppen

Beschreibung Operation Parameter Rückgabewert
Mandant starten resumeClient - -
Mandant stoppen suspendClient - -

Starten, beenden etc. Aufgaben

Beschreibung Operation Parameter Rückgabewert
Ein Objekt starten executeObject

Objektname, Zeitzone, Input-Parameter für READ-Masken, Startzeitpunkt, auf manuelle Freigabe warten

siehe auch Befüllen von :Read-Masken

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, Wiederanlauf-Punkt, Starttyp beibehalten, auf manuelle Freigabe warten, Wiederanlauf nur 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 bei den beiden Status-Parametern jeweils den System-Returncode an.

-
Aufgabe sofort starten startTaskImmediately RunID -
Info des Detailfensters der Aufgabe auslesen getTaskDetails RunID

Auflistung vom Typ DetailGroup

Verwenden Sie den Typ DetailGroupItem, um die einzelnen Infos wie z.B: den Status abzufragen

Workflow und Workflow-Aufgaben

Beschreibung Operation Parameter Rückgabewert
Haltepunkt in einem Workflow setzen 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:

Verwendung des Webservices

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH