Administrator-Interface

Inhaltsverzeichnis

Dieses Paket hat kein Administrator-Interface, sondern erweitert den Web-Service um neue Operationen.

Siehe auch

Um diese Funktion nutzen zu können, muss ein neuer Web-Service in der Ansicht Web-Services der Administrator-Oberfläche konfiguriert werden.

Inhalte

Prozesse & Automatisierung
- Web-Services

Das Hauptmerkmal dieses Pakets ist die Erweiterung der generischen Schnittstelle von OTRS, die es OTRS ermöglicht, Anfragen von externen Systemen zur Interaktion mit verknüpften Objekten anzunehmen.

Jede Operation erfordert einen gültigen Benutzernamen des Agenten und ein Passwort oder eine Sitzungs-ID. Diese Sitzungs-ID kann mit Hilfe der Operation SessionCreate vom Sitzungskonnektor, der standardmäßig in OTRS verfügbar ist, erhalten werden.

Dieses Paket enthält die folgenden Operationen der generischen Schnittstelle.

Link::LinkAdd: Diese Operation wird verwendet, um eine Verknüpfung zwischen zwei Objekten herzustellen.
Link::LinkDelete: Diese Operation wird verwendet, um eine Verknüpfung zwischen zwei Objekten zu entfernen.
Link::LinkDeleteAll: Diese Operation wird verwendet, um alle Verknüpfungen eines Objekts zu entfernen.
Link::LinkList: Diese Operation zeigt alle Verknüpfungen eines Objekts an, optional eingeschränkt durch ein anderes Objekt, den Verknüpfungstyp und die Verknüpfungsrichtung.
Link::PossibleLinkList: Diese Operation zeigt alle möglichen Verknüpfungstypen zwischen Objekten, die im OTRS-System registriert sind.
Link::PossibleObjectsList: Diese Operation zeigt alle Objekte an, die zur Verknüpfung verwendet werden können.
Link::PossibleTypesList: Diese Operation zeigt alle möglichen Verbindungstypen zwischen zwei gegebenen Objekten.

Aufgrund der Art der generischen Schnittstelle und der in diesem Paket enthaltenen Operationen wird eine externe Software benötigt, um die Anfragen an das OTRS-System zu senden.

Für Tests empfehlen wir die Verwendung von:

OTRS Perl SOAP Requester Skript: Einige der Variablen in diesem Skript wie URL, NameSpace und Operation müssen geändert werden, um dem aktuellen Web Service, der auszuführenden Operation und den zu sendenden Daten zu entsprechen.
SoapUI von SMARTBEAR: Dies ist eine Open-Source-Software zum Testen von Web-Services mit SOAP-Nachrichten.

Verwendung

Die Funktion „Objekt verknüpfen“ bietet die Möglichkeit, Elemente (z.B. Tickets, ITSM Changes) von Objekten (z.B. Ticket, ITSMChangeManagement) zu verknüpfen, um eine logische Verbindung herzustellen.

Um diese Anfragen leichter lesbar und verständlich zu machen, finden Sie hier einige SOAP-Anfragevorlagen mit den Parametern für jede Operation.

Anfragevorlage `Link::LinkAdd`

<RootElement>
    <UserLogin>?</UserLogin>
    <Password>?</Password>
    <SessionID>?</SessionID>
    <SourceObject>?</SourceObject>
    <SourceKey>?</SourceKey>
    <TargetObject>?</TargetObject>
    <TargetKey>?</TargetKey>
    <Type>?</Type>
    <State>?</State>
</RootElement>

UserLogin und Passwort: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
SessionID: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
SourceObject: Objekt, von dem die Verknüpfung ausgeht.
SourceKey: ID des Ursprungsobjekts.
TargetObject: Objekt, auf das die Verknüpfung zeigt.
TargetKey: ID des Zielobjekts.
Type: Art der Verknüpfung.
State: Status der Verknüpfung, normalerweise Valid.

Anfragevorlage `Link::LinkDelete`

<RootElement>
    <UserLogin>?</UserLogin>
    <Password>?</Password>
    <SessionID>?</SessionID>
    <Object1>?</Object1>
    <Key1>?</Key1>
    <Object2>?</Object2>
    <Key2>?</Key2>
    <Type>?</Type>
</RootElement>

UserLogin und Passwort: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
SessionID: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
Object1: Objekt, von dem die Verknüpfung ausgeht.
Key1: ID des Ursprungsobjekts.
Object2: Objekt, auf das die Verknüpfung zeigt.
Key2: ID des Zielobjekts.
Type: Art der Verknüpfung.

Anfragevorlage `Link::LinkDeleteAll`

<RootElement>
    <UserLogin>?</UserLogin>
    <Password>?</Password>
    <SessionID>?</SessionID>
    <Object>?</Object>
    <Key>?</Key>
</RootElement>

UserLogin und Passwort: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
SessionID: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
Object: Objekt, von dem die Verknüpfungen ausgehen.
Key: ID des Ursprungsobjekts.

Anfragevorlage `Link::LinkList`

<RootElement>
    <UserLogin>?</UserLogin>
    <Password>?</Password>
    <SessionID>?</SessionID>
    <Object>?</Object>
    <Key>?</Key>
    <Object2>?</Object2>
    <State>?</State>
    <Type>?</Type>
    <Direction>?</Direction>
</RootElement>

UserLogin und Passwort: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
SessionID: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
Object: Objekt, von dem die Verknüpfungen ausgehen.
Key: ID des Ursprungsobjekts.
Object2: Optionale Einschränkung des Objekts, auf das die Verknüpfungen zeigen.
State: Status der Links, normalerweise Gültig.
Type: Optionale Einschränkung des Verknüpfungstyps.
Direction: Optionale Einschränkung der Verknüpfungsrichtung (Source oder Target).

Anfrageformular `Link::PossibleLinkList`

<RootElement>
    <UserLogin>?</UserLogin>
    <Password>?</Password>
    <SessionID>?</SessionID>
</RootElement>

UserLogin und Passwort: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
SessionID: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.

Anfrageformular `Link::PossibleObjectsList`

<RootElement>
    <UserLogin>?</UserLogin>
    <Password>?</Password>
    <SessionID>?</SessionID>
    <Object>?</Object>
</RootElement>

UserLogin und Passwort: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
SessionID: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
Object: Objekt, von dem die Verknüpfungen ausgehen.

Anfrageformular `Link::PossibleTypesList`

<RootElement>
    <UserLogin>?</UserLogin>
    <Password>?</Password>
    <SessionID>?</SessionID>
    <Object1>?</Object1>
    <Object2>?</Object2>
</RootElement>

UserLogin und Passwort: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
SessionID: Wird zur Authentifizierung verwendet. Dies ist optional, aber es muss entweder ein Benutzer-Login mit einem Passwort oder eine Session-ID angegeben werden.
Object1: Objekt, von dem die Verknüpfung ausgeht.
Object2: Objekt, auf das die Verknüpfung zeigt.

Beispiele

Die folgenden Beispiele verwenden alle Objekte und Typen, die in OTRS mit der Standardkonfiguration verfügbar sind. Wenn Sie die Standardkonfigurationen der Verknüpfungen geändert haben, müssen die Beispiele möglicherweise angepasst werden.

Neue Verknüpfung erstellen

In diesem Beispiel wird gezeigt, wie eine Verknüpfung unter Verwendung der Operation Link::LinkAdd des generischen Interface erstellt wird.

Senden Sie die folgende SOAP-Anfrage an das OTRS-System.

<RootElement>
    <UserLogin>johnsmith</UserLogin>
    <Password>Secret123</Password>
    <SourceObject>Ticket</SourceObject>
    <SourceKey>1</SourceKey>
    <TargetObject>Ticket</TargetObject>
    <TargetKey>2</TargetKey>
    <Type>Normal</Type>
    <State>Valid</State>
</RootElement>