pp108 : GetCaseInstances

GetCaseInstances

  

This Web service operation is used to query the case instances through the query parameters. The GetCaseInstances is a part of the Method Set Case Instance Execution 4.2 Web service interface with the namespace http://schemas.cordys.com/casemanagement/execution/1.0.

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <GetCaseInstances
                xmlns="http://schemas.cordys.com/casemanagement/execution/1.0">
   			 <cursor
                numRows="20" position="0"/>
  			 <model space="all">Case/PatientHealthCheck</model>
  			 <status>
  				  <status>NEW</status>
   				  <status>INPROGRESS</status>
   			 </status>
   			 <target>
    				  <target>cn=Manager,cn=organizational roles,
                                        o=system,cn=cordys,cn=defaultInst,o=vanenburg.com</target>
  			 </target>
   			<startedon>4</startedon>
   			<duein>2</duein>
   			<hierarchy>true</hierarchy>
  		</GetCaseInstances>
    </SOAP:Body>
</SOAP:Envelope>
Request Parameters

Parameter

Description

Mandatory

Accepted Input Values

model

Qualified name of the case model

Yes

  

status

Status of the case model

No

The possible values are:

  • NEW
  • INPROGRESS
  • COMPLETED
  • ABORTED
  • SUSPENDED
  • TERMINATED

target

Target to which the case model is assigned at the design time

No

The possible values are:

  • Role DN
  • User DN
  • Fully Qualified Domain Name (FQDN) of the Worklist
  • FQDN of the Team

startedon

Value from which the case instances are started

No

For example, the current date is 31-May-2011 and the requirement is to obtain all the case instances, which were started from 26-May-2011. The value of this parameter must be 6 (current date - given date).

Note: Negative values are ignored.

duein

Count of the due days relative to the current date

No

For example, the current date is 31-May-2011 and the requirement is to obtain all the case instances, which are due on 02-June-2011. The value of this parameter must be 2 (given date - current date).

Note: The duration value will be calculated till the midnight of the provided date. Negative values are allowed.

SOAP Response

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
 <SOAP:Body>
   <GetCaseInstancesResponse xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns="http://schemas.cordys.com/casemanagement/execution/1.0">
     <cursor xmlns="http://schemas.cordys.com/casemanagement/execution/1.0" numRows="20" />
       <tuple>
          <old>
            <CASE_INSTANCE>
                 <CASE_INSTANCE_IDENTIFIERS>
                     <CURRENTSTATE name="CurrentState" description="Current Functional State">State</CURRENTSTATE>
                     <NAME name="name" description="name">John</NAME>
                     <DESIGNATION name="designation" description="designation">Soft Ware Engineer</DESIGNATION>
                  </CASE_INSTANCE_IDENTIFIERS>
                  <CASE_INSTANCE_ID>005056C0-0008-11E0-EF73-9E0348A133C8</CASE_INSTANCE_ID>
                  <CASE_MODEL>005056C0-0008-11E0-EE44-FFA1DF1153C8</CASE_MODEL>
                  <MODEL_REVISION>005056C0-0008-11E0-EF73-9385D04953C8</MODEL_REVISION>
                  <STATUS>NEW</STATUS>
                  <STARTED_ON>1305097481792</STARTED_ON>
                  <STARTED_BY>cn=JDoe,cn=organizational users,o=system,cn=cordys,cn=defaultInst,o=vanenburg.com</STARTED_BY>
                  <LASTMODIFIED_ON>1305097481792</LASTMODIFIED_ON>
                  <LASTMODIFIED_BY>cn=JDoe,cn=organizational users,o=system,cn=cordys,
                   cn=defaultInst,o=vanenburg.com</LASTMODIFIED_BY>
                  <DUE_ON>1305270281792</DUE_ON>
                  <SOURCE_TYPE>CASE</SOURCE_TYPE>
                  <SOURCE>00215A63-1B7C-11E2-EC74-E947348E7FD6</SOURCE>
                  <ROOT_ID>005056C0-0008-11E0-EF73-9E0348A0D3C8</ROOT_ID>
                  <PRIORITY>3</PRIORITY>
            </CASE_INSTANCE>
          </old>
       </tuple>       
       <tuple>
          <old>
            <CASE_INSTANCE>
                   <CASE_INSTANCE_IDENTIFIERS>
                           <CURRENTSTATE name="CurrentState" description="Current Functional State">State</CURRENTSTATE>
                           <NAME name="name" description="name">John</NAME>
                           <DESIGNATION name="designation" description="designation">Soft Ware Engineer</DESIGNATION>
                   </CASE_INSTANCE_IDENTIFIERS>
                   <CASE_INSTANCE_ID>005056C0-0008-11E0-EF75-585A717F53C8</CASE_INSTANCE_ID>
                   <CASE_MODEL>005056C0-0008-11E0-EE44-FFA1DF1153C8</CASE_MODEL>
                   <MODEL_REVISION>005056C0-0008-11E0-EF73-9385D04953C8</MODEL_REVISION>
                   <STATUS>NEW</STATUS>
                   <STARTED_ON>1305103418019</STARTED_ON>
                   <STARTED_BY>cn=JDoe,cn=organizational users,o=system,cn=cordys,cn=defaultInst,o=vanenburg.com</STARTED_BY>
                   <LASTMODIFIED_ON>1305103418019</LASTMODIFIED_ON>
                   <LASTMODIFIED_BY>cn=JDoe,cn=organizational users,o=system,cn=cordys,cn=defaultInst,
                    o=vanenburg.com</LASTMODIFIED_BY>
                   <DUE_ON>1305276218190</DUE_ON>
                   <SOURCE_TYPE>CASE</SOURCE_TYPE>
                   <SOURCE>00215A63-1B7C-11E2-EC74-E947348E7FD6</SOURCE>    
                   <ROOT_ID>005056C0-0008-11E0-EF75-585A717EF3C8</ROOT_ID>
                   <PRIORITY>3</PRIORITY>
           </CASE_INSTANCE>
         </old>
     </tuple>
   </GetCaseInstancesResponse>
 <SOAP:Body>
</SOAP:Envelope>
Response Parameters

Refer to GetCaseInstance for more information on response parameters.