Adminisztrátori felület¶
Ennek a csomagnak nincs adminisztrátori felülete, de kiegészíti a webszolgáltatást új műveletekkel.
Lásd még
A funkció használatához egy új webszolgáltatást kell beállítani az adminisztrátori felület Webszolgáltatások képernyőjén.
Ennek a csomagnak a fő funkciója, hogy kiegészítse az OTRS általános felületét, ami lehetővé teszi az OTRS-nek, hogy kéréseket fogadjon külső rendszerektől az objektum összekapcsolásával való együttműködéshez.
Minden művelet érvényes ügyintézői bejelentkezési nevet és jelszót vagy egy munkamenet-azonosítót igényel. Ez a munkamenet-azonosító a SessionCreate
művelet használatával szerezhető be a munkamenet-csatolótól, amely alapértelmezetten elérhető az OTRS-ben.
Ez a csomag a következő általános felületi műveleteket tartalmazza.
Link::LinkAdd
- Ez a művelet két objektum közötti kapcsolat létrehozásához használható.
Link::LinkDelete
- Ez a művelet két objektum közötti kapcsolat eltávolításához használható.
Link::LinkDeleteAll
- Ez a művelet egy objektum összes kapcsolatának eltávolításához használható.
Link::LinkList
- Ez a művelet megjeleníti egy objektum összes kapcsolatát, választhatóan egy másik objektum, kapcsolattípus és kapcsolatirány szerint korlátozottan.
Link::PossibleLinkList
- Ez a művelet megjeleníti az objektumok közötti összes lehetséges kapcsolattípust, amely az OTRS rendszerben regisztrálva van.
Link::PossibleObjectsList
- Ez a művelet megjeleníti az összes olyan objektumot, amely használható összekapcsoláshoz.
Link::PossibleTypesList
- Ez a művelet megjeleníti a két megadott objektum közötti összes lehetséges kapcsolattípust.
Az általános felület és az ebben a csomagban mellékelt műveletek természeténél fogva egy külső szoftver szükséges, hogy kéréseket küldjön az OTRS rendszernek.
Tesztelési célból a következők használatát javasoljuk:
- OTRS Perl SOAP kérelmező parancsfájl: az ebben a parancsfájlban lévő néhány változó megváltoztatása szükséges, hogy illeszkedjen a jelenlegi webszolgáltatáshoz, a végrehajtandó művelethez és az elküldendő adatokhoz. Ilyen változók például az
URL
, aNameSpace
és azOperation
. - A SMARTBEAR által fejlesztett SoapUI: egy nyílt forráskódú szoftver, amelyet SOAP üzeneteket használó weboldalak teszteléséhez terveztek.
Használat¶
Az objektumok összekapcsolása funkció az objektumokból (például Ticket
, ITSMChangeManagement
) származó elemek (például jegyek, változások) összekapcsolásához szolgáltat funkcionalitást, annak érdekében hogy logikai kapcsolatot biztosítson.
Ezen kérések egyszerűen olvashatóvá és megérthetővé tételéhez itt van néhány SOAP kéréssablon, amely az egyes műveletek paramétereit mutatja be.
A Link::LinkAdd
kéréssablon¶
<RootElement>
<UserLogin>?</UserLogin>
<Password>?</Password>
<SessionID>?</SessionID>
<SourceObject>?</SourceObject>
<SourceKey>?</SourceKey>
<TargetObject>?</TargetObject>
<TargetKey>?</TargetKey>
<Type>?</Type>
<State>?</State>
</RootElement>
UserLogin
ésPassword
- Hitelesítéshez használható. Ez elhagyható, de vagy egy felhasználói bejelentkezési nevet és egy jelszót, vagy egy munkamenet-azonosítót meg kell adni.
SessionID
- Hitelesítéshez használható. Ez elhagyható, de vagy egy felhasználói bejelentkezési nevet és egy jelszót, vagy egy munkamenet-azonosítót meg kell adni.
SourceObject
- Az az objektum, ahonnan a kapcsolat származik.
SourceKey
- A kapcsolatot létesítő objektum azonosítója.
TargetObject
- Az az objektum, ahova a kapcsolat mutat.
TargetKey
- A célobjektum azonosítója.
Type
- A kapcsolat típusa.
State
- A kapcsolat állapota, általában
Valid
.
A Link::LinkDelete
kéréssablon¶
<RootElement>
<UserLogin>?</UserLogin>
<Password>?</Password>
<SessionID>?</SessionID>
<Object1>?</Object1>
<Key1>?</Key1>
<Object2>?</Object2>
<Key2>?</Key2>
<Type>?</Type>
</RootElement>
UserLogin
ésPassword
- Hitelesítéshez használható. Ez elhagyható, de vagy egy felhasználói bejelentkezési nevet és egy jelszót, vagy egy munkamenet-azonosítót meg kell adni.
SessionID
- Hitelesítéshez használható. Ez elhagyható, de vagy egy felhasználói bejelentkezési nevet és egy jelszót, vagy egy munkamenet-azonosítót meg kell adni.
Object1
- Az az objektum, ahonnan a kapcsolat származik.
Key1
- A kapcsolatot létesítő objektum azonosítója.
Object2
- Az az objektum, ahova a kapcsolat mutat.
Key2
- A célobjektum azonosítója.
Type
- A kapcsolat típusa.
A Link::LinkDeleteAll
kéréssablon¶
<RootElement>
<UserLogin>?</UserLogin>
<Password>?</Password>
<SessionID>?</SessionID>
<Object>?</Object>
<Key>?</Key>
</RootElement>
UserLogin
ésPassword
- Hitelesítéshez használható. Ez elhagyható, de vagy egy felhasználói bejelentkezési nevet és egy jelszót, vagy egy munkamenet-azonosítót meg kell adni.
SessionID
- Hitelesítéshez használható. Ez elhagyható, de vagy egy felhasználói bejelentkezési nevet és egy jelszót, vagy egy munkamenet-azonosítót meg kell adni.
Object
- Az az objektum, ahonnan a kapcsolatok származnak.
Key
- A kapcsolatot létesítő objektum azonosítója.
A Link::LinkList
kéréssablon¶
<RootElement>
<UserLogin>?</UserLogin>
<Password>?</Password>
<SessionID>?</SessionID>
<Object>?</Object>
<Key>?</Key>
<Object2>?</Object2>
<State>?</State>
<Type>?</Type>
<Direction>?</Direction>
</RootElement>
UserLogin
ésPassword
- Hitelesítéshez használható. Ez elhagyható, de vagy egy felhasználói bejelentkezési nevet és egy jelszót, vagy egy munkamenet-azonosítót meg kell adni.
SessionID
- Hitelesítéshez használható. Ez elhagyható, de vagy egy felhasználói bejelentkezési nevet és egy jelszót, vagy egy munkamenet-azonosítót meg kell adni.
Object
- Az az objektum, ahonnan a kapcsolatok származnak.
Key
- A kapcsolatot létesítő objektum azonosítója.
Object2
- Azon objektum elhagyható korlátozása, ahova a kapcsolatok mutatnak.
State
- A kapcsolatok állapota, általában
Valid
. Type
- A kapcsolat típusának elhagyható korlátozása.
Direction
- A kapcsolat irányának elhagyható korlátozása (
Source
vagyTarget
).
A Link::PossibleLinkList
kéréssablon¶
<RootElement>
<UserLogin>?</UserLogin>
<Password>?</Password>
<SessionID>?</SessionID>
</RootElement>
UserLogin
ésPassword
- Hitelesítéshez használható. Ez elhagyható, de vagy egy felhasználói bejelentkezési nevet és egy jelszót, vagy egy munkamenet-azonosítót meg kell adni.
SessionID
- Hitelesítéshez használható. Ez elhagyható, de vagy egy felhasználói bejelentkezési nevet és egy jelszót, vagy egy munkamenet-azonosítót meg kell adni.
A Link::PossibleObjectsList
kéréssablon¶
<RootElement>
<UserLogin>?</UserLogin>
<Password>?</Password>
<SessionID>?</SessionID>
<Object>?</Object>
</RootElement>
UserLogin
ésPassword
- Hitelesítéshez használható. Ez elhagyható, de vagy egy felhasználói bejelentkezési nevet és egy jelszót, vagy egy munkamenet-azonosítót meg kell adni.
SessionID
- Hitelesítéshez használható. Ez elhagyható, de vagy egy felhasználói bejelentkezési nevet és egy jelszót, vagy egy munkamenet-azonosítót meg kell adni.
Object
- Az az objektum, ahonnan a kapcsolatok származnak.
A Link::PossibleTypesList
kéréssablon¶
<RootElement>
<UserLogin>?</UserLogin>
<Password>?</Password>
<SessionID>?</SessionID>
<Object1>?</Object1>
<Object2>?</Object2>
</RootElement>
UserLogin
ésPassword
- Hitelesítéshez használható. Ez elhagyható, de vagy egy felhasználói bejelentkezési nevet és egy jelszót, vagy egy munkamenet-azonosítót meg kell adni.
SessionID
- Hitelesítéshez használható. Ez elhagyható, de vagy egy felhasználói bejelentkezési nevet és egy jelszót, vagy egy munkamenet-azonosítót meg kell adni.
Object1
- Az az objektum, ahonnan a kapcsolat származik.
Object2
- Az az objektum, ahova a kapcsolat mutat.
Példák¶
A következő példák használják az összes olyan objektumot és típust, amelyek elérhetők az alapértelmezett beállítást használó OTRS-ben. Ha megváltoztatta a kapcsolat alapértelmezett beállításait, akkor a példákat esetleg módosítani kell.
Új kapcsolat létrehozása¶
Ez a példa azt mutatja be, hogy hogyan kell létrehozni egy kapcsolatot a Link::LinkAdd
általános felületi művelet használatával.
Küldje el a következő SOAP kérést az OTRS rendszernek.
<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>
A kiszolgáló válaszának valami ehhez hasonlónak kell lennie.
<namesp1:RootElementResponse> <Success>1</Success> </namesp1:RootElementResponse>
Kapcsolat eltávolítása¶
Ez a példa azt mutatja be, hogy hogyan kell egy korábban létrehozott kapcsolatot eltávolítani a Link::LinkDelete
általános felületi művelet használatával.
Küldje el a következő SOAP kérést az OTRS rendszernek.
<RootElement> <UserLogin>johnsmith</UserLogin> <Password>Secret123</Password> <Object1>Ticket</Object1> <Key1>1</Key1> <Object2>Ticket</Object2> <Key2>2</Key2> <Type>Normal</Type> </RootElement>
A kiszolgáló válaszának valami ehhez hasonlónak kell lennie.
<namesp1:RootElementResponse> <Success>1</Success> </namesp1:RootElementResponse>
Az összes kapcsolat eltávolítása¶
Ez a példa azt mutatja be, hogy alternatív módon hogyan kell egy korábban létrehozott kapcsolatot (és a jegy összes egyéb kapcsolatát) eltávolítani a Link::LinkDeleteAll
általános felületi művelet használatával.
Küldje el a következő SOAP kérést az OTRS rendszernek.
<RootElement> <UserLogin>johnsmith</UserLogin> <Password>Secret123</Password> <Object>Ticket</Object> <Key>1</Key> </RootElement>
A kiszolgáló válaszának valami ehhez hasonlónak kell lennie.
<namesp1:RootElementResponse> <Success>1</Success> </namesp1:RootElementResponse>
Az összes kapcsolat megjelenítése¶
Ez a példa megjeleníti egy objektum összes kapcsolatát a Link::LinkList
általános felületi művelet használatával.
Küldje el a következő SOAP kérést az OTRS rendszernek.
<RootElement> <UserLogin>johnsmith</UserLogin> <Password>Secret123</Password> <Object>Ticket</Object> <Key>1</Key> <State>Valid</State> </RootElement>
A kiszolgáló válaszának valami ehhez hasonlónak kell lennie.
<namesp1:RootElementResponse> <RootElement> <Direction>Source</Direction> <Key>2</Key> <Object>Ticket</Object> <Type>Normal</Type> </RootElement> <RootElement> <Direction>Source</Direction> <Key>3</Key> <Object>Ticket</Object> <Type>ParentChild</Type> </RootElement> <RootElement> <Direction>Target</Direction> <Key>4</Key> <Object>Ticket</Object> <Type>ParentChild</Type> </RootElement> </namesp1:RootElementResponse>
Az összes lehetséges hivatkozás megjelenítése¶
Ez a példa megjeleníti az objektumok közötti összes lehetséges kapcsolattípust a Link::PossibleLinkList
általános felületi művelet használatával.
Küldje el a következő SOAP kérést az OTRS rendszernek.
<RootElement> <UserLogin>johnsmith</UserLogin> <Password>Secret123</Password> </RootElement>
A kiszolgáló válaszának valami ehhez hasonlónak kell lennie.
<namesp1:RootElementResponse> <RootElement> <Object1>Ticket</Object1> <Object2>Ticket</Object2> <Type>Normal</Type> </RootElement> <RootElement> <Object1>Ticket</Object1> <Object2>Ticket</Object2> <Type>ParentChild</Type> </RootElement> </namesp1:RootElementResponse>
Az összes lehetséges objektum megjelenítése¶
Ez a példa megjeleníti egy megadott objektummal összekapcsolható összes objektumot a Link::PossibleObjectsList
általános felületi művelet használatával.
Küldje el a következő SOAP kérést az OTRS rendszernek.
<RootElement> <UserLogin>johnsmith</UserLogin> <Password>Secret123</Password> <Object>Ticket</Object> </RootElement>
A kiszolgáló válaszának valami ehhez hasonlónak kell lennie.
<namesp1:RootElementResponse> <PossibleObject>Ticket</PossibleObject> </namesp1:RootElementResponse>
Az összes lehetséges típus megjelenítése¶
Ez a példa megjeleníti a két objektum közötti összes kapcsolattípust a Link::PossibleTypesList
általános felületi művelet használatával.
Küldje el a következő SOAP kérést az OTRS rendszernek.
<RootElement> <UserLogin>johnsmith</UserLogin> <Password>Secret123</Password> <Object1>Ticket</Object1> <Object2>Ticket</Object2> </RootElement>
A kiszolgáló válaszának valami ehhez hasonlónak kell lennie.
<namesp1:RootElementResponse> <PossibleType>Normal</PossibleType> <PossibleType>ParentChild</PossibleType> </namesp1:RootElementResponse>