Hi KD_10675014,
There does not appear to be any REST API for document to document usage, document to document reference or document to document described by relationships. There are however, thos elinks for WTParts, so it is surprising that the equivalent for documents do not exist (well not really surprising in my opinion because WTDocument relationships seem to be an after thought).
How I solved this was to write my own custom java backend code for each of the above 3 relationship types. I'm quite happy to share my code. I have several "versions" for creating a link, updating a link, deleting a link of each of the 3 types with or without attributes, with or without revisions. There has been a lot of frustrations because even though on the surface you would think you could use all the code for WTParts and just replace with WTDocument (master, usage...), it simply does not work the same. For example, if you wish to update a custom attribute on a document usage link, you cannot. YOu have to delete the existing link and create a new one with the new value for the attribute. With WTPartUsage you can however, just update the attribute.
Here is one sample function for creating a document ot document usage link. You can ignote the iWebAppId part. It is used to get the appropriate user for the organization because we have multiple organizations. You could hardcode the principal user if desired.
public Boolean setDocDocLink(String sUser, String sParentDocNo, String sChildDocNumber, String sCheckInComments, String sDocUsageType, int iWebAppId) throws WTException, RemoteException, InvocationTargetException
{
if (!RemoteMethodServer.ServerFlag)
{
RemoteMethodServer ms = RemoteMethodServer.getDefault();
Class[] argTypes = {String.class, String.class, String.class, String.class, String.class, int.class};
Object[] argValues = {sUser, sParentDocNo, sChildDocNumber, sCheckInComments, sDocUsageType, iWebAppId};
ms.invoke("setDocDocLink", null, this, argTypes, argValues);
return true;
}
SessionContext.newContext();
String sUsername = getBackendUser(iWebAppId);
SessionHelper.manager.setPrincipal(sUsername);
Transaction trans = new Transaction();
try
{
trans.start();
WTDocument DocChild = getDocumentByNumber(sChildDocNumber);
if(DocChild != null)
{
WTDocumentMaster masterChild = (WTDocumentMaster)DocChild.getMaster();
WTDocument DocParent = getDocumentByNumber(sParentDocNo);
WTDocumentUsageLink link = new WTDocumentUsageLink();
/* Quantity DocQty = new Quantity();
DocQty.setAmount(dQty);
if(sUnit.equals(""))
DocQty.setUnit(QuantityUnit.EA);
else
DocQty.setUnit(QuantityUnit.toQuantityUnit(sUnit));
link.setQuantity(DocQty);
*/ Folder checkoutFolder = wt.vc.wip.WorkInProgressHelper.service.getCheckoutFolder();
CheckoutLink col = null;
col = WorkInProgressHelper.service.checkout((WTDocument)DocParent,checkoutFolder,"");
WTDocument DocParent2 = (WTDocument)col.getWorkingCopy();
PersistableAdapter obj = new PersistableAdapter(DocParent2,null,Locale.US,new UpdateOperationIdentifier());
obj.load("RegainPortalUser");
obj.set("RegainPortalUser", sUser);
obj.apply();
PersistenceHelper.manager.modify(DocParent2);
link.setTypeDefinitionReference(getTypeDef(sDocUsageType));
link.setRoleAObject(DocParent2);
link.setRoleBObject(masterChild);
link = (WTDocumentUsageLink)PersistenceHelper.manager.store(link);
PersistenceHelper.manager.refresh(link);
DocParent2 = (WTDocument)WorkInProgressHelper.service.checkin(DocParent2,sCheckInComments);
}
trans.commit();
trans = null;
return true;
}
catch(Throwable t)
{
throw new ExceptionInInitializerError(t);
}
finally
{
if(trans != null)
{
trans.rollback();
}
}
}
Also, I always set a custom attribute for our front end user which is the bit about RegainPortalUser. If you don't want to set an attribute on the parent document, just remove that bit.
Finally I have a useful funciton that returns the parent document object from the document number, because this is what needs to be checked out and checked back in after creating the link.
public static WTDocument getDocumentByNumber(String sDocNumber) throws WTException
{
// TODO Auto-generated method stub
QuerySpec qs = new QuerySpec(WTDocument.class);
SearchCondition condition = new SearchCondition(WTDocument.class, WTDocument.NUMBER, SearchCondition.EQUAL, sDocNumber);
qs.appendWhere(condition, new int[]{0});
QueryResult qr = PersistenceHelper.manager.find((StatementSpec)qs);
WTDocument doc = null;
WTDocument doc2 = null;
while(qr.hasMoreElements())
{
doc = (WTDocument)qr.nextElement();
break;
}
if(doc != null)
{
QueryResult qr2 = VersionControlHelper.service.allVersionsOf(doc);
doc2= (WTDocument)qr2.nextElement();
}
return doc2;
}
This setDocDocLink function I expose as a REST API so I can call it from my custom frontend.
Unfortunately, every part of the process has to be customised it seems.
