Page tree
Skip to end of metadata
Go to start of metadata

REST - Delete

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

  • Returns: nothing, when the operation is successful; an error message when the operation is unsuccessful.
  • Supported Content-Type: application/x-www-form-urlencoded
  • Accepts a URL with URL-encoded parameters and record data. For more information about general URL conventions, see REST Interface.
  • Additionally, the URL must contain one or more record identifiers and the delete rule name, and optionally the substitute record identifiers. 

Notes

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

  • ERROR_IF_DEPENDANTS - operation fails when there are any dependent records. 
  • APPLY_DELETE_WHERE_POSSIBLE - tries to delete all dependent records. When delete cannot be done, an attempt to unlink the record is made. 
  • DELETE_WHERE_POSSIBLE_OTHERWISE_UNLINK - same as above.
  • APPLY_UNLINK - tries to unlink dependent records. 
  • UNLINK_WHERE_POSSIBLE_OTHERWISE_DELETE - tries to unlink all dependent records; when unlink cannot be done an attempt to delete the record is made. 
  • REPLACE_WITH_ANOTHER - tries to link dependent records to the substitute one specified in replacementKeys. 

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  Agiloft is available on localhost, port 8080 and is called "Demo". Delete the record updated in the REST Update Example.

The following request is issued: 

 http://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('http://localhost:8080/ewws/EWDelete?$KB=Demo
        &$table=Contacts.Employees&$login=admin&$password=qwerty
        &$lang=en&id=358
        &deleteRule=APPLY_DELETE_WHERE_POSSIBLE');
    }