SOAP API - unlinkCase

The table summarizes the SOAP API - unlinkCase.

Request Uses the UnlinkCaseRequestelement (from the BusinessDataServices schema).
Parameter notes
  • sourceCaseReference: The case reference of the case data whose association you want to remove. For example, BDS-2-com.example.gddemo.Customer-1-1. You must only specify one source case reference.
  • targetCaseReference: The case reference of the case data you want to disassociate from your source case data. For example, BDS-2-com.example.gddemo.Claim-4-0. You must specify at least one targetCaseReference. There is no limit to how many you can specify. (The association relationship must be specified as multiplicity for there to be unlimited target case references. See TIBCO Business Studio™ Modeling Guide for more information.)
  • targetRoleName: The name of the association you specified when you created in the association using linkCase. For example, claim.
Response Returns an UnlinkCaseResponseelement (from the BusinessDataServices schema).
Example Request:
<soapenv:Body>
   <api:UnlinkCaseRequest>
      <sourceCaseReference>BDS-2-com.example.gddemo.Customer-1-1</sourceCaseReference>
      <targetCaseReference>BDS-2-com.example.gddemo.Car-4-1</targetCaseReference>
      <targetCaseReference>BDS-2-com.example.gddemo.Car-6-1</targetCaseReference>
      <targetRoleName>cars</targetRoleName>
   </api:UnlinkCaseRequest>
</soapenv:Body>
  Response:
<SOAP-ENV:Body>
   <UnlinkCaseResponse xmlns="http://api.bds.tibco.com">
     <caseReference
     xmlns="">BDS-2-com.example.gddemo.Customer-1-2</caseReference>
     <targetCaseReference
     xmlns="">BDS-2-com.example.gddemo.Car-4-2</targetCaseReference>
     <targetCaseReference
     xmlns="">BDS-2-com.example.gddemo.Car-6-2</targetCaseReference>
   </UnlinkCaseResponse>
</SOAP-ENV:Body>