SOAP API - linkDocument

The table summarizes the SOAP API - linkDocument.

Request Uses the LinkDocumentRequest element (from the DocumentService schema)
Parameter notes
Response Returns a LinkDocumentResponse element (from the DocumentService schema).
Example - Passing a document reference Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:doc="http://document.api.bds.tibco.com">
   <soapenv:Header/>
   <soapenv:Body>
      <doc:LinkDocumentRequest>
         <targetOwner>
            <caseReference>BDS-1-com.example.ordermodel.Order-3-0</caseReference>
         </targetOwner>
         <documentReference>DocumentID-f61fd51d-3895-40a0-8952-1a4bd992b2da;1.0</documentReference>
      </doc:LinkDocumentRequest>
   </soapenv:Body>
</soapenv:Envelope>
Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <LinkDocumentResponse xmlns="http://document.api.bds.tibco.com"/>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope> 
Example - Passing a document specifier Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:doc="http://document.api.bds.tibco.com">
   <soapenv:Header/>
   <soapenv:Body>
      <doc:LinkDocumentRequest>
         <targetOwner>
            <caseReference>BDS-1-com.example.ordermodel.Order-3-0</caseReference>
         </targetOwner>
         <documentSpecifier>
            <id>39066491-f769-48d5-a7b9-ed7f224bd1e0;1.0</id>
         </documentSpecifier>
      </doc:LinkDocumentRequest>
   </soapenv:Body>
</soapenv:Envelope>
Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <LinkDocumentResponse xmlns="http://document.api.bds.tibco.com">
         <reference xmlns="">DocumentID-39066491-f769-48d5-a7b9-ed7f224bd1e0;1.0</reference>
      </LinkDocumentResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>