The EWDelete operation deletes the specified records. If any specified record can't be successfully deleted, none of the records are deleted.

Notes

The deleteRule parameter defines one of the following strategies to be applied for dependent records:

The subs parameter is taken in consideration only if the deleteRule REPLACE_WITH_ANOTHER is specified. If used, this parameter should contain identifiers of records from the same table to be used as substitutes. For each record dependent on the record being deleted, a record with a corresponding replacement key will become the parent one.

  • If the specific strategy fails, the error message returned will suggest alternatives to be used.
  • If APPLY_DELETE_WHERE_POSSIBLE or DELETE_WHERE_POSSIBLE_OTHERWISE_UNLINK strategies are used and the configuration of the knowledgebase allows it, a special "Fast Delete" algorithm is used.

Example

Assume an instance of  is available on localhost, port 8080 and is called "Demo". Delete the record updated in the REST Update Example.

The following request is issued: 

 https://localhost:8080/ewws/EWDelete?$KB=Demo
    &$table=Contacts.Employees&$login=admin&$password=qwerty
    &$lang=en&id=358&deleteRule=APPLY_DELETE_WHERE_POSSIBLE 

JavaScript Example

Here is an example for a JavaScript-based client that invokes the REST interface via AJAX: 

    function xmlhttpGet (strURL) {
        var xmlHttpReq=false;
        var self=this;
        // Mozilla/Safari
        if (window.XMLHttpRequest) {
            try {
                netscape.security.PrivilegeManager.
enablePrivilege("UniversalBrowserRead");
            } catch (e) {
                alert("Permission UniversalBrowserRead denied.");
            }
            self.xmlHttpReq=new XMLHttpRequest();
        }// IE
        else if (window.ActiveXObject) {
            self.xmlHttpReq=new ActiveXObject("Microsoft.xmlHTTP");
        }
        self.xmlHttpReq.open('GET', strURL, true);
        self.xmlHttpReq.onreadystatechange=requestComplete;
        self.xmlHttpReq.send(null);
    }
    function requestComplete() {
        if (xmlHttpReq.readyState==4||xmlHttpReq.readyState=="complete") {
            alert ("Delete completed");
        }
    }
    function main() {
        xmlhttpGet('https://localhost:8080/ewws/EWDelete?$KB=Demo
        &$table=Contacts.Employees&$login=admin&$password=qwerty
        &$lang=en&id=358
        &deleteRule=APPLY_DELETE_WHERE_POSSIBLE');
    } 

Related articles