REST API - deleteByID

The table summarizes the REST API - deleteByID.

Request

Format 
DELETE <baseurl>/globaldata/model/<caseType>/<version>/deletebyid
Path parameters
  • 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.
  • version: The version of the case model. For example, 2 or 2.0.0.
Body casePayload: Contains the parameters in the CasePayloadArrayType element (from the BusinessDataServices schema).

This contains the case identifier of the case to be deleted. The case payload must be constructed to match the structure of the case data defined in your business object model. See Obtaining Information From TIBCO Business Studio.

Response

JSON Returns a 200 OK response header with an empty response body.
XML Returns a 200 OK response header with an empty response body.

Example

Request 
DELETE <baseurl>/globaldata/model/com.example.hastings.Order/1/deletebyid
Body 
<xml-fragment>
<casePayload>
<![CDATA[
<hastings:OrderElement xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:hastings="http://example.com/hastings" xsi:type="hastings:Order">
<orderNum>56643</orderNum>
</hastings:OrderElement>
]]>
</casePayload>
</xml-fragment>
Response 
<?xml version="1.0" encoding="UTF-8"?>
    <xml-fragment/>