Verknüpfen von Objekten mit REST-Webdiensten

Der erste Schritt besteht darin, dem Objekt, das Sie für die Integration in den Endpunkt verwenden möchten, das REST-Webdienstverhalten hinzuzufügen.

So fügen Sie das REST-Webdienstverhalten einem Objekt hinzu:

1. Öffnen Sie in Object Designer das Objekt, mit dem Sie den REST-Webdienst verwenden möchten.
2. Wählen Sie das Objekt auf oberster Ebene des Baums Attribute und klicken Sie dann im Raster Eigenschaften neben Verhalten auf .
   Das Dialogfeld zur Verhaltensauswahl wird aufgerufen.
3. Wählen Sie REST-Webdienst in der Liste Verfügbare Elemente aus und klicken Sie anschließend auf .
   REST-Webdienst wird in die Liste Ausgewählte Elemente verschoben.
4. Klicken Sie auf OK und speichern Sie die Änderungen.
   Das Dialogfeld für die Verhaltensauswahl wird geschlossen und ein neues Element, REST-Webdienste, wird im Raster Eigenschaft angezeigt.
   Es werden außerdem vier neue Attribute für das Objekt erstellt: Textteil der Erstellungsanfrage für REST-Dienst, Erstellungsstatus für REST-Dienst, Erstellungsanfrage-URI für REST-Dienst sowie eine Beziehung mit der Bezeichnung Vorlage Textteil für REST-Dienst-Erstellungsanfrage, eine Beziehung zu einem neuen Referenzlistenobjekt mit dem Namen ObjektTextteil. (Object steht für den Namen des Objekts, dem Sie das Verhalten hinzugefügt haben.)

Für jedes neu erstellte Objekt benötigen Sie ein Fenster.

5. Klicken Sie im Raster Eigenschaften neben REST-Webdienste auf .
   Das Dialogfeld "REST-Webdienste" wird angezeigt.
6. Geben Sie auf der Registerkarte Anforderung die URI des gewünschten Endpunkts in das Feld Endpunkt-URI ein.

Im Feld Endpunkt-URI können Sie Platzhaltervariablen einschließen. Dies wird meistens für PATCH gemacht.

7. Wählen Sie je nach Bedarf POST, PATCH oder DELETE aus.
   Post wird in der Regel zum Erstellen von Elementen verwendet und Post zum Aktualisieren vorhandener Elemente. Wenn Sie ein Element mithilfe des REST-Webdienstes erstellen und danach das Objekt mit dem REST-Webdienst aktualisieren möchten, müssen Sie zwei Objekte erstellen: eines, um das Element mit Post zu erstellen, und eines, um das Element mit Patch zu aktualisieren.
8. Wählen Sie in der Dropdownliste Inhaltstyp den Inhaltstyp aus, den Sie senden möchten.
9. Wählen Sie in der Liste Authentifizierungstyp den Typ der erforderlichen Authentifizierung aus: Keine, Einfach, API-Schlüssel (Kopfzeile), OAuth2 (Clientanmeldeinformationen) oder OAuth2 (Kennwort) zusammen mit zusätzlichen Parametern, je nach Bedarf.
10. Klicken Sie auf OK.

In manchen Situationen bietet es sich an, das REST-Verhalten vorübergehend zu deaktivieren. Sie können dies für ein bestimmtes Objekt durchführen, indem Sie das Kontrollkästchen Aktivieren im Dialogfeld "REST-Webdienste" deaktivieren.

Wenn Sie weitere Aktionen an dem mithilfe des REST-Webdienstes erstellen Datensatz durchführen möchten, müssen Sie den Pfad zu der eindeutigen Kennung angegeben, die Sie von der externen Anwendung erhalten haben, und den Speicherort in Service Desk festlegen, an dem Sie die Informationen speichern möchten.

So speichern Sie eindeutige Kennungen:

1. Geben Sie auf der Registerkarte Antwortzuordnung im Dialogfeld "Verhaltensauswahl" in das Feld Quelle den Pfad zur eindeutigen Kennung ein, die Sie von Ihrer externen Anwendung erhalten haben.
   Sie können Elemente in der Quell-Payload mit Punkten identifizieren (dot notation). Geben Sie * ein, wenn Sie die komplette Antwort verwenden möchten.
2. Geben Sie in das Feld Ziel das Service Desk-Attribut vom Typ Zeichenfolge ein, um anzugeben, wo in Service Desk der zurückgegebene Wert gespeichert werden soll.
   Dies erfolgt im Format {_Anfrage/Feld}.
3. Wählen Sie in der Dropdownliste Akzeptieren den Inhaltstyp an, den Sie empfangen möchten.
   Geben Sie bei Auswahl eines XML-Formats in das Feld XML Namespaces mehrere Namespaces ein, indem Sie ein Leerzeichen zwischen die einzelnen Namen einfügen. Beispiel: xmlns:h="http://www.w3.org/TR/html4/" xmlns:r="http://www.beispiel.com/beispiel/"
4. Klicken Sie auf OK.

Nachdem Sie die Verknüpfung zwischen dem Service Desk-Objekt und dem Endpunkt hergestellt haben, können Sie den Textteil der zu sendenden Payload angeben. Die Payload muss das JSON- oder das XML-Format aufweisen. Einige Endpunkte akzeptieren mehrere unterschiedliche Payloads. Beispiel: Ivanti Automation bietet einen einzigen Endpunkt, der Payloads für mehrere RunBooks akzeptiert, wenn das erforderliche RunBook im Textteil der Payload angegeben ist.

Aus diesem Grund wird die Beziehung Vorlage Textteil für REST-Erstellungsanfrage zum Referenzlistenobjekt ObjektTextteil erstellt, wenn Sie das REST-Webdienstverhalten hinzufügen. Dies ermöglicht Ihnen das Erstellen einer Referenzliste (weitere Einzelheiten siehe Neue Referenzlisten erstellen) zum Speichern der verschiedenen Payload-Textteile und anschließend, im Rahmen Ihrer Prozedur, das Bereitstellen eines Mechanismus, damit die jeweilige Referenzlisteninstanz ausgewählt werden kann (etwa durch Verwenden von Werttyp bei einer automatischen Aktion; weitere Einzelheiten siehe Dynamische Werte für automatische Aktionen angeben). Durch Hinzufügen von Platzhaltern (ähnlich denen, die zum Angeben dynamischer Werte in automatischen Aktionen verwendet werden) zum ObjektTextteil, können Sie Werte einschließen, die Instanzen von Objekten in Service Desk entnommen wurden, um sie in die Payload aufzunehmen. Falls Sie Platzhaltervariablen verwenden, fügen Sie diese zum Kontext des RESTful-Objekts hinzu.

Jedes Objekt mit dem REST-Verhalten muss in der zugehörigen Referenzliste über mindestens ein Element verfügen, das den jeweiligen Payload-Textteil enthält.

Sie können mithilfe eines Tools wie Swagger Ihren Endpukt aufrufen, um das Design der Payload zu vereinfachen.