SOAP API - listCaseAction

The table summarizes the SOAP API - listCaseAction.

Request Uses the listCaseAction element (from the BusinessService schema).
Parameter notes caseReference - Can be obtained using getCaseReferencesForDataView.
Response Returns a listCaseActionResponse element (from the BusinessService schema).
In the response:
  • CaseActionName - The label specified for the CaseAction process in TIBCO Business Studio.
  • CaseRefParamName - The name of the formal parameter in the CaseAction process; there can be only one formal parameter, and it must be of type CaseRef.
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:bus="http://business.api.busserv.n2.tibco.com">
   <soapenv:Header/>
   <soapenv:Body>
      <bus:listCaseAction getTotalCount="true">
         <includeFormalParameters>true</includeFormalParameters>
         <caseReference>BDS-1-com.example.claimsbusinessdata.Claim-1-0</caseReference>
      </bus:listCaseAction>
   </soapenv:Body>
</soapenv:Envelope>>
Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <listCaseActionResponse xmlns="http://business.api.busserv.n2.tibco.com">
         <totalItems xmlns="">2</totalItems>
         <caseCategory xmlns="">
            <caseActionTemplate caseActionName="Claim-View Case Data" caseClassName="com.example.claimsbusinessdata.Claim" caseRefParamName="ClaimRef" hasFormalParameters="true" moduleName="/Car-Claims-Application/Process Packages/CaseServices.xpdl" processName="ClaimViewCaseData" version="1.0.0.20141015170644573">
               <caseState>LOADED</caseState>
            </caseActionTemplate>
         </caseCategory>
         <caseCategory xmlns="">
            <caseActionTemplate caseActionName="Claim-Update Case Data" caseClassName="com.example.claimsbusinessdata.Claim" caseRefParamName="ClaimRef" hasFormalParameters="true" moduleName="/Car-Claims-Application/Process Packages/CaseServices.xpdl" processName="ClaimUpdateCaseData" version="1.0.0.20141015170644573">
               <caseState>AWAITINGDISPATCH</caseState>
            </caseActionTemplate>
         </caseCategory>
      </listCaseActionResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>