pp108 : GetCaseInstance

GetCaseInstance

  


This Web service operation returns the details of the case instance for the provided case instance ID. The GetCaseInstance is a part of the CaseInstanceExecution 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>
        <GetCaseInstance xmlns="http://schemas.cordys.com/casemanagement/execution/1.0">
            <caseinstanceid>005056C0-0008-11E0-EE48-87535AD473C8</caseinstanceid>
        </GetCaseInstance>
    </SOAP:Body>
</SOAP:Envelope>
Request Parameters

Parameter

Description

Mandatory

Accepted Input Values

caseinstanceid

Unique identifier of the case instance. The case instance ID can be obtained from any of the following:

  • The ID returned in response to the CreateCase invocation
  • The Workflow.getCaseInstanceId Web API is invoked from a human task of the case instance

Yes

String

SOAP Response

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <GetCaseInstanceResponse
            xmlns="http://schemas.cordys.com/casemanagement/execution/1.0" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">

            <tuple>
  	     <old>
   		<CASE_INSTANCE>
  		  <BPM_MODEL_REVISION>
   			  <OVERVIEW_FORM
                                null="true"
                                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                            xsi:nil="true"/>
    		  </BPM_MODEL_REVISION>
   		  <BPM_MODEL>
    			 <MODEL_NAME>emp case model</MODEL_NAME>
    		  </BPM_MODEL>
    		  <CASE_INSTANCE_IDENTIFIERS>
    			 <CURRENTSTATE>Default State</CURRENTSTATE>
     			 <NAME>John</NAME>
    			 <DESIGNATION>Software Engineer</DESIGNATION>
   		       <ID>10884</ID>
    		  </CASE_INSTANCE_IDENTIFIERS>
    		  <CASE_INSTANCE_ID>005056C0-0008-11E0-EE48-87535AD473C8</CASE_INSTANCE_ID>
    		  	<CASE_MODEL>005056C0-0008-11E0-EE44-FFA1DF1153C8</CASE_MODEL>
    			<MODEL_REVISION>005056C0-0008-11E0-EE44-FFA1DF1133C8</MODEL_REVISION>
    			<STATUS>INPROGRESS</STATUS>
    			<STARTED_ON>1304069819768</STARTED_ON>
    			<STARTED_BY>cn=JDoe,cn=organizational users,o=system,cn=cordys,cn=defaultInst,o=vanenburg.com</STARTED_BY>
    			<LASTMODIFIED_ON>1304315176258</LASTMODIFIED_ON>
    			<LASTMODIFIED_BY>cn=JDoe,cn=organizational users,o=system,cn=cordys,cn=defaultInst,o=vanenburg.com</LASTMODIFIED_BY>
    			<DUE_ON
                            null="true"
                            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
                        <SOURCE_TYPE>CASE</SOURCE_TYPE>
                        <SOURCE>00215A63-1B7C-11E2-EC74-E947348E7FD6</SOURCE>
    			<ROOT_ID>005056C0-0008-11E0-EE48-87535AD473C8</ROOT_ID>
                        <PRIORITY>3</PRIORITY>
   		 </CASE_INSTANCE>
 	    </old>
       </tuple>
        </GetCaseInstanceResponse>
    </SOAP:Body>
</SOAP:Envelope>
Response Parameters

Refers to the source from where the case is created.

Parameter

Description

OVERVIEW_FORM

Case overview form associated with the current case instance

MODEL_NAME

Name of the case model

CURRENTSTATE

Current state of the case instance

CASE_INSTANCE_ID

Unique identifier of the case instance

CASE_INSTANCE_IDENTIFIERS

Case identifiers of the case instance on which the search is performed

STATUS

Status of the case instance. The possible values are:

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

STARTED_ON

Time stamp when the case instance was started

STARTED_BY

User who started the case instance

DUE_ON

Date on which the case instance must be completed

LASTMODIFIED_ON

Time stamp when the case instance was last modified

LASTMODIFIED_BY

Last user who modified the case instance

SOURCE_TYPE

Application type that created the instance. The possible values are:

  • Web Service - The default value when a case instance is created using the CreateCase API. You can also customize the value as a part of the parameter source in the CreateCase API.
  • CASE - The value when a case instance is triggered from another case instance.
  • PROCESS - The value when a case instance is triggered from another BPM instance.

SOURCE

 Parent process instance ID from which the case instance is instantiated
PRIORITY Priority of the case instance