delete Operation
The delete
operation deletes the existing rows of the top-level service data object that a request
payload passes. Depending on the requirements of the business object, you may delete the
child and descendant entities.
-
Hard delete, for example, delete a row from the database
-
Soft delete, for example, update the row status to indicate that it is deleted
A service may expose additional delete operations on child or descendant
objects, which don't depend on the top-level entity, if it is a functional
requirement. For example, the Sales Lead
service exposes a deleteSalesLead
operation as well as a deleteSalesLeadProduct, deleteSalesLeadResource, and other delete operations on the child
objects.
Operation Signature
For the Sales Lead service, the following is the
signature of the deleteSalesLead
operation that accepts the Sales Lead business object to be deleted. This operation
accepts a MklLead object as the input
parameter. The primary key or the alternate key attributes are required. You need
not populate all the other attributes of the object.
<element name="deleteSalesLead">
<complexType>
<sequence>
<element name="saleLead" type="ns1:MklLead"/>
</sequence>
</complexType>
</element>The deleteSalesLead operation returns an empty response payload.
<element name="deleteSalesLeadResponse">
<complexType>
<sequence/>
</complexType>
</element>
Example
This example deletes the Sales Lead service object with 300100041938883 as the internal identifier.
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:deleteSalesLead
xmlns:ns1="http://xmlns.oracle.com/apps/marketing/leads/leadService/types/">
<ns1:salesLead
xmlns:ns2="http://xmlns.oracle.com/oracle/apps/marketing/leadMgmt/leads/leadService/">
<ns2:LeadId>300100054316102</ns2:LeadId>
</ns1:salesLead>
</ns1:deleteSalesLead>
</soap:Body>
</soap:Envelope>The deleteSalesLead operation performs a hard delete of the Sales Lead
object and all the descendant objects, and returns an empty response payload.
<ns0:deleteSalesLeadResponse xmlns="" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns0="http://xmlns.oracle.com/apps/marketing/leadMgmt/leads/leadService/types/"
xmlns:wsa="http://www.w3.org/2005/08/addressing" xmlns:wsu="http://docs.oasis-open.org/
wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"/>
Related Operations
To delete a list of business objects passed in the
request payload, you can use the process operation.