SOAP API handles
A handle is special URL object that references a particular object instance in an IBM® 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. For example, a trigger can pass a handle to a procedure, which uses it as a parameter in a SOAP call to a 3rd-party system. The 3rd-party system can then issue a SOAP request back to Marketing Operations to start a procedure that updates an attribute.
Members of the Handle class have factory methods for creating handles from various types of URLs. Examples follow.
- Approval
http://mymachine:7001/plan/affiniumplan.jsp?cat=approvaldetail& approvalid=101
- Asset
http://mymachine:7001/plan/affiniumplan.jsp?cat=asset& assetMode=VIEW_ASSET&assetid=101
- Asset Folder
http://mymachine:7001/plan/affiniumplan.jsp?cat=folder&id=101
- Asset Library
http://mymachine:7001/plan/affiniumplan.jsp?cat=library&id=101
- Attachment
http://mymachine:7001/plan/affiniumplan.jsp?cat=attachmentview& attachid=101&parentObjectId=101&parentObjectType=project
- Financial Account
http://mymachine:7001/plan/affiniumplan.jsp?cat=accountdetails& accountid=101
- Folder
http://mymachine:7001/plan/affiniumplan.jsp?cat=grouping_folder& folderid=1234
- Invoice
http://mymachine:7001/plan/affiniumplan.jsp?cat=invoicedetails& invoiceid=134
- Invoice line item
http://mymachine:7001/plan/affiniumplan.jsp?cat=invoicedetails& invoiceid=134&line_item_id=101
- Marketing object
http://mymachine:7001/plan/affiniumplan.jsp?cat=componenttabs& componentid=creatives&componentinstid=1234
- Marketing object grid
http://mymachine:7001/plan/affiniumplan.jsp?cat=componenttabs& componentid=creatives&componentinstid=1234&gridid=grid
- Marketing object grid row
http://mymachine:7001/plan/affiniumplan.jsp?cat=componenttabs& componentid=creatives&componentinstid=1234&gridid=grid&gridrowid=101
- Plan team
http://mymachine:7001/plan/affiniumplan.jsp?cat=teamdetails& func=edit&teamid=100001
- Plan user
http://mymachine:7001/plan/affiniumplan.jsp?cat=adminuserpermissions& func=edit&userId=101
- Program
http://mymachine:7001/plan/affiniumplan.jsp?cat=programtabs&programid=125
- Program grid
http://mymachine:7001/plan/affiniumplan.jsp?cat=programtabs& programid=1234&gridid=grid
- Program grid row
http://mymachine:7001/plan/affiniumplan.jsp?cat=programtabs& programid=1234&gridid=grid&gridrowid=101
- Project
http://mymachine:7001/plan/affiniumplan.jsp?cat=projecttabs& projectid=1234
- Project grid
http://mymachine:7001/plan/affiniumplan.jsp?cat=projecttabs& projectid=1234&gridid=grid
- Project grid row
http://mymachine:7001/plan/affiniumplan.jsp?cat=projecttabs& projectid=1234&gridid=grid&gridrowid=101
- Project line item
http://mymachine:7001/plan/affiniumplan.jsp?cat=projecttabs& projectid=1234&projectlineitemid=123&projectlineitemisversionfinal=false
- Workflow stage
http://mymachine:7001/plan/affiniumplan.jsp?cat=projectworkflow& projectid=1234&taskid=5678
- Workflow task
http://mymachine:7001/plan/affiniumplan.jsp?cat=projectworkflow& projectid=1234&taskid=5678