ℹ️ Dieses Automic Tutorial ist Teil von PEM und wurde am 24.10.2023 veröffentlicht.

Mehr über Webservice REST Jobs

In diesem Beitrag zeige ich dir Schritt für Schritt, wie du REST-Clients in Automic erstellen und verwenden kannst, um Anfragen an REST-APIs zu senden.

Voraussetzungen

Bevor wir loslegen können, gibt es zwei wichtige Voraussetzungen, die du erfüllen musst:

Einen aktiven REST-Agenten: Stelle sicher, dass ein aktiver RA Webservice REST-Agent in deiner Agentenübersicht verfügbar ist.
Objektvorlagen: Stelle sicher, dass die Objektvorlagen verfügbar sind, indem du ein neues Objekt erstellst und nach “REST” suchst.

Sehen wir uns die Schritte für das Verbindungsobjekt an:

  1. Allgemeine Informationen:
    Definiere die URL deiner REST API. Dies ist das einzige Pflichtfeld in diesem Objekt.
  2. Authentifizierung:
    Definiere die Art der Authentifizierung, die deine REST-API erwartet. Automic unterstützt die gängigsten Methoden und die Anmeldedaten werden sicher in der Automic-Datenbank gespeichert.
  3. Ressourcen:
    Definiere die Ressourcen, die die REST-API anbietet. Dies hilft uns später bei der Formulierung der Abfragen im Job.
  4. Header und Abfrageparameter:
    Hier können zusätzliche Header und Abfrageparameter definiert werden, um die Abfragen zu verfeinern.
  5. Proxy-Einstellungen:
    Auf der Registerkarte “Proxy” kann bei Bedarf ein Proxy für die Verbindung zur REST-API eingerichtet werden.

Erstellen eines REST-Jobs

Wie bei jedem Jobtyp muss zunächst der Agent definiert werden, auf dem der Job ausgeführt werden soll. Da die Anmeldedaten im CONN-Objekt gespeichert sind, müssen keine weiteren Angaben gemacht werden.

In der Registerkarte “WebService” wählst du das zuvor erstellte CONN-Objekt aus. Hier kannst du auch die automatisch generierte URI überschreiben sowie Header und Request-Parameter hinzufügen, falls für bestimmte Request-Typen spezielle Einstellungen erforderlich sind.

Nun kannst du deine Anfrage abschicken und das Ergebnis überprüfen.

Informationen aus den Reports extrahieren

Möglicherweise möchtest du Informationen aus den Automic-Reports extrahieren. Dies ist auch in REST-Jobs möglich.

Auf der Registerkarte “Response” kannst du die Antworten analysieren. Hier legst du fest, welche Header-Einträge und Daten aus dem Body der Antwort extrahiert werden sollen. Du kannst verschiedene Parsing-Methoden auswählen und festlegen, was mit den extrahierten Daten geschehen soll.

Fazit

Zusammenfassend benötigen Webservice REST Jobs einen Webservice REST Agenten und ein CONN Objekt. Die Antwort auf die Anfrage und der HTTP-Return-Code sind immer im Report verfügbar und können im Response-Tab analysiert werden, um Informationen für die spätere Verwendung zu extrahieren.