Using the SmartObject OData v3 API in JavaScript

The following sample javascript function shows how to get data from a SmartObject using the OData API. The sample uses Basic authentication, but you can also use OAuth by setting up the header similarly to the code described in the Workflow REST API topics.

Copy

Get data from a SmartObject using the OData API

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
$.ajax({
    type: 'GET',
    // TODO: Your URL will be different to the one below.
    // Use the OData REST API Configuration page on the K2 Management site to determine base URL
    // then append the SmartObject system name
    url: 'https://k2.denallix.com/api/odata/v3/Sales_Product_SampleDatabase',
    dataType: 'json',
    // As CORS is used, this must be set to true
    crossDomain: false,
    // Basic authentication is set in the header, enter appropriate user name and password for your environment.
    // The xhr (XMLHttpRequest) function below sends authorization details to the server.
    // This line creates a hash of the user name and password:
    // window.btoa(unescape(encodeURIComponent("[USERNAME]" + ':' + "[PASSWORD]")))
    beforeSend: function (xhr) {
        xhr.setRequestHeader('Authorization', 'Basic ' + window.btoa(unescape(encodeURIComponent("administrator" + ':' + "K2pass!"))));
        xhr.setRequestHeader("Content-Type", "application/json; charset=UTF-8");
    },
    // On success, we write a 'success' message to the console and stringify the returned JSON to display,
    // for example, in the <div id="t1"><div> tag on a web page
    success: function (json_data) {
        console.log('success');
        $("#tl").html(JSON.stringify(json_data));
    },
    // In case of error, show an alert
    error: function () {
        alert('Failed!');
    }
})