REST-API-Handles

Ein Handle ist ein spezielles URL-Objekt, das innerhalb einer Unica Plan-Instanz auf eine bestimmte Objektinstanz verweist. Handles umfassen den Komponententyp, IDs von internen Daten und die Basis-URL einer Instanz.

Handles, die von dem API verwendet oder generiert werden, können zu einer vollständigen URL externalisiert werden. Sie können die resultierende URL auf verschiedene Arten verwenden. Sie können die URL verwenden, um eine Ansicht der Komponente auf der grafischen Benutzeroberfläche von Unica Plan zu öffnen, um diese Ansicht als E-Mail-Nachrichten zu senden oder um sie in einer anderen Prozedur als Parameter einzusetzen.

Handles sind lediglich für eine bestimmte Unica Plan-Serviceinstanz oder -Clusterinstanz gültig, sie sind aber immer für die Laufzeit des bereitgestellten Service gültig. Das bedeutet, Handles können zur späteren Verwendung in einer Datei gespeichert werden, sie können jedoch nicht für den Zugriff auf Komponenten einer anderen Instanz von Unica Plan verwendet werden. Diese Einschränkung gilt auch für Instanzen auf demselben physischen Hostserver. Unica Plan stellt einen Mechanismus zur Verfügung, mit dem verschiedene Basis-URLs der aktuellen Instanz zugeordnet werden können, um das Verlagern einer Instanz zu einem anderen Server zu ermöglichen (etwa bei Störungen im System).

Handles sind clientunabhängig.

Die Mitglieder der Handle-Klasse verfügen über Factory-Methoden zum Erstellen von Handles aus verschiedenen Typen von URLs. Nachfolgend sind Beispiele für Handles aufgeführt.

Projekthandles:

{"value":{"multiTypeValue":"http://mymachine:9999/plan/affiniumplan
.jsp?cat=projecttabs&projectid=102"}}
{"value":{"multiTypeValue":"http://mymachine:9999/plan/affiniumplan
.jsp?cat=projecttabs&projectid=103"}}
{"value":{"multiTypeValue":"http://mymachine:9999/plan/affiniumplan
.jsp?cat=projecttabs&projectid=104"}}
{"value":{"multiTypeValue":"http://mymachine:9999/plan/affiniumplan
.jsp?cat=projecttabs&projectid=105"}}
{"value":{"multiTypeValue":"http://mymachine:9999/plan/affiniumplan
.jsp?cat=projecttabs&projectid=106"}}

Programmhandles:

{"value":{"multiTypeValue":"http://mymachine:9999/plan/affiniumplan
.jsp?cat=programtabs&programid=112"}}
{"value":{"multiTypeValue":"http://mymachine:9999/plan/affiniumplan
.jsp?cat=programtabs&programid=113"}}
{"value":{"multiTypeValue":"http://mymachine:9999/plan/affiniumplan
.jsp?cat=programtabs&programid=114"}}
{"value":{"multiTypeValue":"http://mymachine:9999/plan/affiniumplan
.jsp?cat=programtabs&programid=115"}}
{"value":{"multiTypeValue":"http://mymachine:9999/plan/affiniumplan
.jsp?cat=programtabs&programid=116"}}

Benutzerhandles:

{"value":{"multiTypeValue":"http://mymachine:9021/plan/affiniumplan
.jsp?cat=adminuserpermissions&func=edit&userId=2"}}
{"value":{"multiTypeValue":"http://mymachine:9021/plan/affiniumplan
.jsp?cat=adminuserpermissions&func=edit&userId=3"}}
{"value":{"multiTypeValue":"http://mymachine:9021/plan/affiniumplan
.jsp?cat=adminuserpermissions&func=edit&userId=4"}}
{"value":{"multiTypeValue":"http://mymachine:9999/plan/affiniumplan
.jsp?cat=adminuserpermissions&func=edit&userId=5"}}
{"value":{"multiTypeValue":"http://mymachine:9021/plan/affiniumplan
.jsp?cat=adminuserpermissions&func=edit&userId=6"}}

Team-Handles:

{"value":{"multiTypeValue":"http://mymachine:9021/plan/affiniumplan
.jsp?cat=teamdetails&func=edit&teamid=100001"}}
{"value":{"multiTypeValue":"http://mymachine:9021/plan/affiniumplan
.jsp?cat=teamdetails&func=edit&teamid=100002"}}
{"value":{"multiTypeValue":"http://mymachine:9021/plan/affiniumplan
.jsp?cat=teamdetails&func=edit&teamid=100003"}}

Task-Handles:

{"value":{"multiTypeValue":"http://mymachine:9021/plan/affiniumplan
.jsp?cat=projectworkflow&projectid=102&taskid=106"}}
{"value":{"multiTypeValue":"http://mymachine:9021/plan/affiniumplan
.jsp?cat=projectworkflow&projectid=103&taskid=141"}}
{"value":{"multiTypeValue":"http://mymachine:9021/plan/affiniumplan
.jsp?cat=projectworkflow&projectid=104&taskid=176"}}
{"value":{"multiTypeValue":"http://mymachine:9021/plan/affiniumplan
.jsp?cat=projectworkflow&projectid=105&taskid=211"}}
{"value":{"multiTypeValue":"http://mymachine:9021/plan/affiniumplan
.jsp?cat=projectworkflow&projectid=106&taskid=246"}}

Genehmigungshandle: 

{"value":{"multiTypeValue":"http://mymachine:9021/plan/affiniumplan
.jsp?cat=approvaldetail&approvalid=149"}}
{"value":{"multiTypeValue":"http://mymachine:9021/plan/affiniumplan
.jsp?cat=approvaldetail&approvalid=150"}}
{"value":{"multiTypeValue":"http://mymachine:9021/plan/affiniumplan
.jsp?cat=approvaldetail&approvalid=151"}}

Marketingobjekthandles:

hRestTestMO_01={"value":{"multiTypeValue":"http//mymachine:9999/plan/affiniumplan
.jsp?cat=componenttabs&componentid=resttestmo02&componentinstid=130"}}
hRestTestMO_02={"value":{"multiTypeValue":"http://mymachine:9999/plan/affiniumplan
.jsp?cat=componenttabs&componentid=resttestmo02&componentinstid=130"}}
hRestTestMO_03={"value":{"multiTypeValue":"http://mymachine:9999/plan/affiniumplan
.jsp?cat=componenttabs&componentid=resttestmo02&componentinstid=131"}}
hRestTestMO_04={"value":{"multiTypeValue":"http://mymachine:9999/plan/affiniumplan
.jsp?cat=componenttabs&componentid=resttestmo02&componentinstid=132"}}
hRestTestMO_05={"value":{"multiTypeValue":"http://mymachine:9999/plan/affiniumplan
.jsp?cat=componenttabs&componentid=resttestmo02&componentinstid=133"}}

Projektanforderunghandle:

{"value":{"multiTypeValue":"http://mymachine:9999/plan/affiniumplan
.jsp?cat=projecttabs&projectid=122"}}

Assetbibliothekhandle:

{"value":{"multiTypeValue":"http://mymachine:9999/plan/affiniumplan
.jsp?cat=library&id=101"}}

Asset-Handles:

{"value":{"multiTypeValue":"http://mymachine:9999/plan/affiniumplan
.jsp?cat=asset&assetMode=VIEW_ASSET&assetid=123"}}
{"value":{"multiTypeValue":"http://mymachine:9999/plan/affiniumplan
.jsp?cat=asset&assetMode=VIEW_ASSET&assetid=124"}}