REST API handles

A handle is special URL object that references a particular object instance in an HCL® Marketing Operations instance. Handles include the component type, internal data identifier, and an instance base URL.

Handles used or generated by the API can be externalized to a full URL. You can use the resulting URL in different ways. You can use the URL to open a view of the component in the Marketing Operations GUI, send it in email messages, or use it in another procedure as a parameter.

Handles are valid only for a particular Marketing Operations service instance or clustered instance, but are valid for the lifetime of the deployed service. As a result, handles can be saved in a file for later reference, but they cannot be used to access components on another Marketing Operations instance. This restriction also applies to instances on the same physical host server. Marketing Operations does provide, however, a mechanism for mapping different base URLs to the current instance to accommodate relocating an instance to another server (for example, if the equipment malfunctions).

Handles are client-independent.

Members of the Handle class have factory methods for creating handles from various types of URLs. Examples follow for several handles.

Project handles:

{"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"}}

Program handles:

{"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"}}

User handles:

{"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"}}

Approval handle: 

{"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"}}

Marketing object handles:

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"}}

Project request handle:

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

Asset library handle:

{"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"}}