GetCaseInstanceDetails

This Web service operation returns the details of the Case instance for the provided Case instance ID. The GetCaseInstanceDetails 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>
        <GetCaseInstanceDetails xmlns="http://schemas.cordys.com/casemanagement/execution/1.0">
            <InstanceId>001CC435-DD29-11E3-E8DA-5B50F01ABF2A</InstanceId>
            <FilterCriteria>
                <GetStateInstances>true</GetStateInstances>
                <GetActivityInstances>true</GetActivityInstances>
            </FilterCriteria>
        </GetCaseInstanceDetails>
    </SOAP:Body>
</SOAP:Envelope>

Request Parameters

Parameter

Description

Mandatory?

Accepted values

InstanceId

Unique identifier of the Case instance as available in the run time. 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

GetStateInstances

Boolean value to determine whether to retrieve the state instance details also along with the Case instance details for the provided Case instance ID.

No

true (Default)
false

GetActivityInstances

Boolean value to determine whether to retrieve the activity instance details also along with the Case instance details for the provided Case instance ID.

No

true(Default)
false

SOAP Response

<GetCaseInstanceDetailsResponse
    xmlns="http://schemas.cordys.com/casemanagement/execution/1.0" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <CASE_INSTANCE>
        <BPM_MODEL_REVISION>
            <OVERVIEW_FORM
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
        </BPM_MODEL_REVISION>
        <BPM_MODEL>
            <MODEL_NAME>DeliverCaseModel</MODEL_NAME>
        </BPM_MODEL>
        <CASE_INSTANCE_IDENTIFIERS>
            <CURRENTSTATE dataType="STRING">Delivered</CURRENTSTATE>
        </CASE_INSTANCE_IDENTIFIERS>
        <CASE_INSTANCE_ID>001CC435-DD29-11E3-E8DA-5B50F01ABF2A</CASE_INSTANCE_ID>
        <CASE_MODEL>001CC435-DD29-11E3-E8BC-EA84B46697FE</CASE_MODEL>
        <MODEL_REVISION>001CC435-DD29-11E3-E8DA-5B50F0193F2A</MODEL_REVISION>
        <STATUS>INPROGRESS</STATUS>
        <STARTED_ON>1383735723288</STARTED_ON>
        <STARTED_BY>cn=mdshahanaz,cn=organizational users,o=system,cn=cordys,cn=build896,o=vanenburg.com</STARTED_BY>
        <LASTMODIFIED_ON>1383735756755</LASTMODIFIED_ON>
        <LASTMODIFIED_BY>cn=mdshahanaz,cn=organizational users,o=system,cn=cordys,cn=build896,o=vanenburg.com</LASTMODIFIED_BY>
        <DUE_ON xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
        <SOURCE_TYPE>Web Service</SOURCE_TYPE>
        <SOURCE>001CC435-DD29-11E3-E8DA-5B6EC595BF2A</SOURCE>
        <ROOT_ID>001CC435-DD29-11E3-E8DA-5B50F01ABF2A</ROOT_ID>
        <PRIORITY>3</PRIORITY>
    </CASE_INSTANCE>
    <ACTIVITY_INSTANCES>
        <ACTIVITY_INSTANCE>
            <CASE_STATE>
                <STATE_NAME>Assigned</STATE_NAME>
            </CASE_STATE>
            <CASE_ACTIVITY>
                <ACTIVITY_NAME>Assign Case</ACTIVITY_NAME>
                <ACTIVITY_TYPE>HUMANTASK</ACTIVITY_TYPE>
                <ACTIVITY_MODEL_ID>001CC435-DD29-11E3-E8BC-E712AD79B7FE</ACTIVITY_MODEL_ID>
            </CASE_ACTIVITY>
            <ACTIVITY_INSTANCE_ID>001CC435-DD29-11E3-E8DA-5B50F01B3F2A</ACTIVITY_INSTANCE_ID>
            <PLANNED_ON>1383735723357</PLANNED_ON>
            <STARTED_ON>1383735723357</STARTED_ON>
            <LASTMODIFIED_ON>1383735739516</LASTMODIFIED_ON>
            <LASTMODIFIED_BY>cn=mdshahanaz,cn=organizational users,o=system,cn=cordys,cn=build896,o=vanenburg.com</LASTMODIFIED_BY>
            <CORRELATION_ID>001CC435-DD29-11E3-E8DA-5B50F01B3F2A</CORRELATION_ID>
            <CURRENT_STATUS>COMPLETED</CURRENT_STATUS>
        </ACTIVITY_INSTANCE>
        <ACTIVITY_INSTANCE>
            <CASE_STATE>
                <STATE_NAME>InProgress</STATE_NAME>
            </CASE_STATE>
            <CASE_ACTIVITY>
                <ACTIVITY_NAME>Execute</ACTIVITY_NAME>
                <ACTIVITY_TYPE>HUMANTASK</ACTIVITY_TYPE>
                <ACTIVITY_MODEL_ID>001CC435-DD29-11E3-E8BC-E712AD75D7FE</ACTIVITY_MODEL_ID>
            </CASE_ACTIVITY>
            <ACTIVITY_INSTANCE_ID>001CC435-DD29-11E3-E8DA-5D05005ABF2A</ACTIVITY_INSTANCE_ID>
            <PLANNED_ON>1383735741326</PLANNED_ON>
            <STARTED_ON>1383735741326</STARTED_ON>
            <LASTMODIFIED_ON>1383735756755</LASTMODIFIED_ON>
            <LASTMODIFIED_BY>cn=mdshahanaz,cn=organizational users,o=system,cn=cordys,cn=build896,o=vanenburg.com</LASTMODIFIED_BY>
            <CORRELATION_ID>001CC435-DD29-11E3-E8DA-5D05005ABF2A</CORRELATION_ID>
            <CURRENT_STATUS>COMPLETED</CURRENT_STATUS>
        </ACTIVITY_INSTANCE>
    </ACTIVITY_INSTANCES>
    <STATE_INSTANCES>
        <STATE_INSTANCE>
            <CASE_STATE>
                <STATE_NAME>Default State</STATE_NAME>
                <STATE_MODEL_ID>RootCaseModelState</STATE_MODEL_ID>
            </CASE_STATE>
            <PLANNED_ON>1383735723309</PLANNED_ON>
            <ENTERED_ON>1383735723309</ENTERED_ON>
			<STATE_INSTANCE_ID>001CC435-DD29-11E3-EC48-00852BBE9F9E</STATE_INSTANCE_ID>
			<PARENT_STATE xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true" />
            <EXITED_ON
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
            <STATUS>ACTIVE</STATUS>
        </STATE_INSTANCE>
        <STATE_INSTANCE>
            <CASE_STATE>
                <STATE_NAME>Assigned</STATE_NAME>
                <STATE_MODEL_ID>001CC435-DD29-11E3-E8BB-5ABA8F1957FE</STATE_MODEL_ID>
            </CASE_STATE>
            <PLANNED_ON>1383735723321</PLANNED_ON>
            <ENTERED_ON>1383735723321</ENTERED_ON>
            <EXITED_ON>1383735739538</EXITED_ON>
			<PARENT_STATE>001CC435-DD29-11E3-EC48-00852BBE9F9E</PARENT_STATE>
            <STATE_INSTANCE_ID>001CC435-DD29-11E3-EC48-00852BBEBF9E</STATE_INSTANCE_ID>
            <STATUS>COMPLETED</STATUS>
        </STATE_INSTANCE>
    </STATE_INSTANCES>
</GetCaseInstanceDetailsResponse>

Response Parameters

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	Timestamp when the Case instance was started
STARTED_BY	User who instantiated the Case model
DUE_ON	Date on which the Case instance must be completed
LASTMODIFIED_ON	Timestamp 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
ACTIVITY_INSTANCES	Details of all the activity instances triggered for the Case instance
ACTIVITY_INSTANCE/ CASE_STATE/STATE_NAME	Name of the state to which the activity belongs
ACTIVITY_INSTANCE/ CASE_ACTIVITY/ACTIVITY_NAME	Name of the Case activity
ACTIVITY_INSTANCE/ ACTIVITY_TYPE	Type of the Case activity. It contains one of the following values: HUMANTASK - if the activity is a user interface BPMTASK - if the activity is a BPM CASETASK - if the activity is a Case model
ACTIVITY_INSTANCE/ ACTIVITY_MODEL_ID	Unique identifier of the activity as available in the design time
ACTIVITY_INSTANCE/ ACTIVITY_INSTANCE_ID	Unique identifier of the activity instance
ACTIVITY_INSTANCE/ PLANNED_ON	Timestamp when the activity was planned
ACTIVITY_INSTANCE/ STARTED_ON	Timestamp when the activity has started
ACTIVITY_INSTANCE/ LASTMODIFIED_ON	Timestamp when the activity was last modified
ACTIVITY_INSTANCE//LASTMODIFIED_BY	DN of the user who modified the activity for the last time
ACTIVITY_INSTANCE//CORRELATION_ID	CORRELATION_ID and ACTIVITY_INSTANCE_ID are the same except in the scenario where users modeled a Case model in such a way that they can set their own generated GUID as the instance_id to instantiate a subprocess or subcase model.
ACTIVITY_INSTANCE//CURRENT_STATUS	Current status of the activity. It contains any of the following values: COMPLETED RELEASED PLANNED OBSOLETE ABORTED
STATE_INSTANCES	Details of all the completed and active states of the Case instance
STATE_INSTANCE/CASE_ STATE/STATE_NAME	Name of the state
STATE_INSTANCE/CASE_ STATE/STATE_MODEL_ID	Unique identifier of the state as available in the design time
STATE_INSTANCE/PLANNED_ON	Time when the state was planned
STATE_INSTANCE/ENTERED_ON	Time when the state has started
STATE_INSTANCE/EXITED_ON	Time when the state has completed
STATE_INSTANCE/STATUS	Current status of the state

pp108 : GetCaseInstanceDetails

GetCaseInstanceDetails

SOAP Request

Request Parameters

SOAP Response

Response Parameters