SOAP API - createCase

The table summarizes the SOAP API - createCase.

Request Uses the CreateCaseRequest element (from the BusinessDataServices schema)
Parameter notes
  • caseType: The case type is the fully qualified name of the case class. For example, com.example.gddemo.Customer. You can obtain this by running getCaseClassInfo.
  • caseModelVersion: The version number of the case model. For example, 2 or 2.0.0.
  • casePayload. This contains the case object to be created. Your request must be constructed to match the structure of the case data defined in your business object model. You can have as many casePayload elements as you want. See Obtaining Information From TIBCO Business Studio.
Response Returns a CreateCaseResponse 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:CreateCaseRequest>
         <caseType>com.example.hastings.Order</caseType>
         <caseModelVersion>1</caseModelVersion>
         <casePayload> <![CDATA[
            <hastings:OrderElement xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:hastings="http://example.com/hastings" xsi:type="hastings:Order">
            <orderNum>884321</orderNum>
            <acctNum>1990-6767</acctNum>
            <orderDate>2015-02-04Z</orderDate>
            <lineItems xsi:type="hastings:LineItem">
               <partNum>CAM6230</partNum>
               <quantity>1</quantity>
               <price>999.0</price>
               <vendor xsi:type="hastings:Vendor">
                  <name>Carrie's Cams</name>
                  <address xsi:type="hastings:Address">
                     <street>87765 Main St.</street>
                     <city>Spokane</city>
                     <state>WA</state>
                     <zip>99776</zip>
                  </address>
                  <contactNames>Carrie Miller</contactNames>
               </vendor>
            </lineItems>
             </hastings:OrderElement>
            ]]>
         </casePayload>
      </api:CreateCaseRequest>
   </soapenv:Body>
</soapenv:Envelope>
Response: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <CreateCaseResponse xmlns="http://api.bds.tibco.com">
         <caseReference xmlns="">BDS-1-com.example.hastings.Order-12-0</caseReference>
      </CreateCaseResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>