SOAP API - getCaseState

The table summarizes the SOAP API - getCaseState.

Request Uses the GetCaseStateRequest element (from the BusinessDataServices schema).
Parameter notes caseReference - Can be obtained using findAllCases or getCaseReferencesForDataView.

includeAllowedValues (optional) - Specify "true" to include all possible case state values in the response. Default = "false".

Response Returns a GetCaseStateResponse element (from the BusinessDataServices schema).
Example Request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.bds.tibco.com">
   <soapenv:Header/>
   <soapenv:Body>
      <api:GetCaseStateRequest includeAllowedValues="true">
         <!--1 or more repetitions:-->
         <caseReference>BDS-1-com.example.statefunbdp.Order-11-0</caseReference>
      </api:GetCaseStateRequest>
   </soapenv:Body>
</soapenv:Envelope>
Response: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <GetCaseStateResponse xmlns="http://api.bds.tibco.com">
         <result xmlns="">
            <caseReference>BDS-1-com.example.statefunbdp.Order-11-0</caseReference>
            <value>
               <label>Created</label>
               <name>CREATED</name>
            </value>
            <allowedValue>
               <label>Created</label>
               <name>CREATED</name>
            </allowedValue>
            <allowedValue>
               <label>Picking</label>
               <name>PICKING</name>
            </allowedValue>
            <allowedValue>
               <label>Dispatched</label>
               <name>DISPATCHED</name>
            </allowedValue>
            <allowedValue>
               <label>Cancelled</label>
               <name>CANCELLED</name>
            </allowedValue>
         </result>
      </GetCaseStateResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>