SOAP API - getCaseSummary
The table summarizes the SOAP API - getCaseSummary.
Request | Uses the GetCaseSummaryRequest element (from the BusinessDataServices schema). |
Parameter notes |
caseReference - Can be obtained using
getCaseReferencesForDataView.
includeLabelAndType (optional) - Specify "true" to include attribute labels and types in the response. Default = "false". |
Response | Returns a GetCaseSummaryResponse 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:GetCaseSummaryRequest includeLabelAndType="true"> <caseReference>BDS-1-com.example.hastings.Order-5-0</caseReference> </api:GetCaseSummaryRequest> </soapenv:Body> </soapenv:Envelope> |
Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <GetCaseSummaryResponse xmlns="http://api.bds.tibco.com"> <caseReferenceDetails xmlns=""> <caseReference>BDS-1-com.example.hastings.Order-5-0</caseReference> <details isCaseIdentifier="true"> <name>orderNum</name> <label>OrderNum</label> <value>66533</value> <type>ATTR_INTEGER</type> </details> <details> <name>acctNum</name> <label>AcctNum</label> <value>786784</value> <type>ATTR_TEXT</type> </details> <details> <name>orderDate</name> <label>OrderDate</label> <value>2015-01-15Z</value> <type>ATTR_DATE</type> </details> </caseReferenceDetails> </GetCaseSummaryResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |
Copyright © Cloud Software Group, Inc. All rights reserved.