GetCaseData |
|
This Web service operation is used to obtain the Case data of a Case instance. The response of this API will have the Case data associated to the Case instance. This data is used to populate the controls used in a Case overview form to provide summarized view of the data. The GetCaseData 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> <GetCaseData xmlns="http://schemas.cordys.com/casemanagement/execution/1.0"> <caseinstanceid>005056C0-0008-11E0-EE45-0DDEAC0C13C8</caseinstanceid> </GetCaseData> </SOAP:Body> </SOAP:Envelope>
Request Parameters
Parameter |
Description |
Mandatory |
Accepted Input Values |
---|---|---|---|
caseinstanceid |
Refers to the unique identifier of the Case instance. The Case instance ID can be obtained from any of the following:
|
Yes |
String |
SOAP Response
<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP:Body> <GetCaseDataResponse xmlns="http://schemas.cordys.com/casemanagement/execution/1.0" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/"> <caseinstanceid>005056C0-0008-11E0-EE45-0DDEAC0C13C8</caseinstanceid> <casedata lockID="005056C0-0008-11E0-EE45-29487A5F13C8"> <data name="sch:emp" xmlns:sch="http://schemas.cordys.com/"> <emp xmlns="http://schemas.cordys.com/" xmlns:case="http://schemas.cordys.com/casemanagement/1.0" xmlns:ns1="http://schemas.cordys.com/" xmlns:ns2="http://schemas.cordys.com/" xmlns:sch="http://schemas.cordys.com/" xmlns:sm="http://www.w3.org/2005/07/scxml"> <id>10881</id> <name>John</name> <designation>Software Engineer</designation> </emp> </data> </casedata> </GetCaseDataResponse> </SOAP:Body> </SOAP:Envelope>
Response Parameters
Parameter |
Description |
---|---|
caseinstanceid |
Refers to the unique identifier of the Case instance |
casedata |
Contains the Case data of the given Case instance |