Handbuch zur API der virtuellen Automatisierung › Informationen zur API der virtuellen Automatisierung › Übersicht zur API der virtuellen Automatisierung

Übersicht zur API der virtuellen Automatisierung

Um die virtuelle API zu verwenden, rufen Sie HTTP-Methoden gegen Ressourcen auf, die jeweils über einen eigenen URI verfügen. Die API verwendet folgende HTTP-Methoden:

• POST - erstellt eine Ressource und stellt dabei die Ressourcenparameter in einem Nachrichtentext bereit. Sie können diese Methode verwenden, um Ereigniserfassung für einen virtuellen Computer bereitzustellen.
• GET - ruft eine aktuelle Darstellung einer Ressource ab. Sie können diese Methode verwenden, um eine Liste von Mandanten oder Informationen zur Bereitstellung abzurufen.
• PUT - aktualisiert eine Ressource, die aktuelle Ressourcendarstellung durch denjenigen ersetzend, den Sie im Meldungstext liefern. Sie können diese Methode verwenden, um vorhandene Anmeldeinformationen der Ereignisquellen zu ändern.
• DELETE - löscht eine Ressource. Sie können diese Methode verwenden, um Ereigniserfassung anzuhalten.

Geben Sie bei jedem API-Aufruf einen gültigen CA User Activity Reporting Module-Benutzer und ein Kennwort oder einen Zertifikatnamen und ein Kennwort an. Verwenden Sie dafür eine HTTP-Standardauthentifizierung (Autorisierungsheader).

Sie können beispielsweise die verfügbaren Methoden verwenden, um die Ereigniserfassung bereitzustellen und auf diese Weise zu steuern:

1. Stellen Sie einen Connector bereit und starten Sie die Ereigniserfassung auf einem virtuellen Computer, indem Sie "POST" zur festen Ressource "/deploycollection" verwenden. "POST" erstellt eine Ressource, die Ihre Ereignisquelle darstellt.

   Diese Methode gibt einen URI für die neue Ressource zurück.

2. Überprüfen Sie den Status der Ereignisquelle, indem Sie "GET" gegen den Ressource-URI verwenden.
3. Entfernen Sie im Bedarfsfall die Ereignisquelle, indem Sie "DELETE" gegen den gleichen URI verwenden.

Einige Ressourcen unterstützen mehrere HTTP-Methoden, andere unterstützen nur eine. Die Dokumentation identifiziert die unterstützten Methoden.