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

REST - Update

The EWUpdate REST operation:

  • Updates the specified record, implementing the Update operation of the REST interface. 
  • Accepts the URL with parameters as per general URL and record data conventions, both of which can be viewed in the REST Interface Overview
  • Returns the encoded data of the updated record.

All parameters must be properly URL-encoded.

Example

Assume an instance of  Agiloft is available on localhost, port 8080 and is called "Demo". Update the record created in the REST Create example section by linking that employee to an opportunity record for company  Agiloft. This operation was not included as part of the create example for illustrative purposes. The same criteria could have been supplied in the create request.

The following needs to be considered:

  • The Employee table is a subtable of People.
  • The link to Opportunities is created via a Linked Field that imports multi-value fields company_name and opportunity_name.
  • We will use the Query By Example capability and supply the name of the company as an example.

The following request is issued: 

 http://localhost:8080/ewws/EWUpdate?$KB=Demo&$table=contacts.employees&$login=admin&$password=qwerty&$lang=en&id=358&_1576_company_name0=:IBM

The following result will be returned in the case of successful modification of the record: 

EWREST_full_name='John Doe';
EWREST__1576_company_name0='IBM';
EWREST_f_group_0='Service Manager';
EWREST_id='358';
EWREST__106_sw_description='Service Management Team';
EWREST__login='jdoe';
EWREST_date_updated='Dec 27 2017 04:40:24';
EWREST_type='employees';
EWREST_date_created='Dec 27 2017 04:34:38';
EWREST_rep_email='example23@example.com';
EWREST_default_approval_title='Document Approval';
EWREST_last_name='Doe';

Here is an example of 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 ("Update completed");
        }
    }
    function main() {
        xmlhttpGet('http://localhost:8080/ewws/EWUpdate?$KB=Demo&$table=contacts.employees&$login=admin&$password=qwerty&$lang=en&id=358&_1576_company_name0=:IBM');
    }

CONTENTS