Webdienste-Referenz

Webdienste-Referenz

Die Webservices-Referenz enthält eine Beschreibung der Methoden, die durch den Client Automation-Webservice verfügbar gemacht werden. Dieser Dienst wird in der Client Automation-Webservice WSDL (webserviceapi.wsdl) beschrieben, die sich auf der obersten Ebene des Client Automation-Installationsverzeichnisses befindet.

Der Client Automation-Webservice umfasst eine Gruppe von Hilfsprogrammmethoden, mit denen Sie einige allgemeine Client Automation-Tasks ausführen können. Diese Methoden sind folgendermaßen logisch gruppiert:

• Authentifizierungs- und Webservices-Management
• Bereitstellung
• Enterprise-Verteilungsfunktionen
• Abfragen
• Software
• Sicherheit
• Einheiten und Gruppen
• OSIM
• Systemüberwachung
• Automatisierungs-Webservice

Jede der dokumentierten Webdienst-Methoden verwendet eine Sitzungs-ID als Eingabe. Diese Sitzungs-ID wird erstellt, wenn Sie sich mit der Methode "Login" beim Client Automation-Webservice anmelden. Die Sitzungs-ID ist für jede Webdienst-Sitzung eindeutig und enthält Informationen zum authentifizierten Benutzer.

Die Webservice-Methoden können auch Client Automation-Sequenzen und Enumerationen als Eingabe verwenden.

Hinweise:

• Mit DMdeploy, OSIM, Sicherheitsbereiche, Software-Jobs, Einheitenerstellung und Automation Services verknüpfte Webservices gelten nur auf dem Domänen-Manager.
• Mit Verteilungs- und Domänengruppen verknüpfte Webservices gelten nur auf dem Enterprise-Manager.
• Wenn Sie einen Nicht-UTF8-Endpunkt verwenden und eine Zeichenfolge für einen Eingabeparameter nicht englische Zeichen enthält, sollte die Zeichenfolge in eine Zeichenfolge mit UTF8-Codierung und anschließend in eine Zeichenfolge mit ISO-8859-1-Codierung konvertiert werden, bevor der Eingabeparameter an die WS-API übergeben wird.
• Ein Sternchen (^m) kennzeichnet obligatorische Parameter.
• Diese Webdienst-API (webserviceapi.wsdl) ist mit Microsoft® .NET Framework, Java Axis und dem Gsoap-Toolkit kompatibel.
• Die Dokumentation für alle Webservice-APIs entspricht der Client Automation-Web Service-WSDL-Datei, nicht dem vom verwendeten Client-Tool generierten Code.
• Der Serviceendpunkt wird in WSDL (definitions\service\port\SOAP:address\location) wie folgt geschrieben:

  http://<servername>/UDSM_R11_WebService/mod_gsoap.dll (unter Windows)
  http:// <servername>/UDSM_R11_WebService (unter Linux)

  Der Pfad ist nur gültig, wenn die Standardwebsite den Port&#160;80 überwacht und SSL nicht konfiguriert ist.

  Ist die Port-Nummer nicht 80 oder ist SSL konfiguriert, muss der Administrator das Dienstende in WSDL manuell ändern, um die abweichenden Port- und SSL-Einstellungen zu konfigurieren. Wenn z. B. der Port in "5256" geändert wird, ist der Service-Endpunkt unter Windows folgender:

  "http://<servername>:5256/UDSM_R11_WebService/mod_gsoap.dll"

  Wenn SSL konfiguriert ist, verwenden Sie https anstatt http.

• Alle der CO & AM-Komponente entsprechenden Webservice-APIs übernehmen die DateTime-Struktur als GMT bzw. geben diese zurück. Alle der SD-Komponente entsprechenden Webdienst-APIs übernehmen die DateTime-Struktur in der Zeitzone des Manager-Computers bzw. geben diese zurück.

Dieses Kapitel enthält folgende Themen:

DSM-Webservices-Endpunkt für UTF-8-Zeichenfolgen

Automation Web Services-Endpunkt

Aufzählungen

Methoden

Sequenzen

Array von Elementen

Einschränkungen

Konfigurationsparameter

SSL-Konfiguration

Weitergeben von systemdefinierten Gruppen als Parameter

DSM-Webservices-Endpunkt für UTF-8-Zeichenfolgen

Client Automation gibt einen WSDL und einen Endpunkt für UTF-8-Zeichenfolgen an. Der neue WSDL und der Endpunkt stehen zusätzlich zum vorhandenen WSDL und Endpunkt zur Verfügung. Im Folgenden finden Sie den neuen WSDL und Endpunkt, die den DSM-Webservices ermöglicht, UTF-8-Zeichenfolgen zu akzeptieren oder zurückzugeben:

WSDL: webserviceapi_utf8.wsdl

Endpunkt: http://<hostname>/DSM_Webservice/mod_gsoap_utf8.dll

Sie können auf den neuen WSDL zugreifen, der auf den neuen Endpunkt zeigt, und zwar mithilfe von http://<hostname>/DSM_Webservice/wsdl.

Automation Web Services-Endpunkt

Sie können den Automation Service-URI und WSDL über einen der folgenden Speicherorte erreichen:

• AutomationService URI - http://<hostname>:[tomcat port number]/axis/services/automationService
• AutomationService WSDL - http://<hostname>:[tomcat port number]/axis/services/automationService?wsdl

Außerdem ist die WSDL-Datei für den Automation Service an folgendem Speicherort verfügbar:

<DSM-Installationsordner>\webservices\wsdl\addons\AutomationService.wsdl