The database API requests use a REST-ful style that is structured as follows:

<Origin>/databases/<Database>[/<DataSet>[/Data]]?<Parameters>

<Origin> = <Protocol>://<Domain>[:<Port>]

<Database> = Database name

<DataSet> = DataSet name

<Parameters> = URL parameters in key=value form and an
               ampersand (&) between parameters

Any content included with database API requests, or returned as a response to the request, should/will be formatted as JSON content. The date/time format used in the JSON content is equivalent to a raw JavaScript Date value: an integer value representing the number of milliseconds since 1 January 1970 UTC.



Get DataSet Columns Request

---

The get dataset columns request enumerates all of the columns in the dataset and database specified in the URL. The column information returned includes the name, type, length (if applicable), and scale (if applicable). The various supported column types are:


For browser client applications, BLOB columns in datasets are defined like variable-length String columns with a null length, and contain a URL that is used to dynamically load the BLOB column from the client application. However, CLOB columns (Character Large Object) in datasets are defined as actual String columns with a null length. For an example of a URL for a BLOB column request, please see the Get DataSet BLOB Column request below.

For non-browser client applications, BLOB columns in datasets are also defined like variable-length String columns with a null length, and contain a URL that is used to dynamically load the BLOB column from the client application. However, CLOB columns (Character Large Object) in datasets are defined with a distinct CLOB type, and are handled like a String column with a null length.


Also, an optional additional String column can be defined for a BLOB column that indicates the MIME type of the BLOB column data in each row. Such a column should be named:

<Column Name>_ContentType

If the web server finds a column with this name, it will use the contents of the column as the Content-Type header when returning the BLOB data in a BLOB column request.

If there is no active session or the session is not authenticated, the request will result in a 403 Forbidden HTTP response.

HTTP Method: GET

HTTP Response Content Type: application/json; charset=utf-8

Example Request:

https://localhost/example/albums

Example Response Content:

{
   "Columns": [{ "Name": "ID",
                 "Type": 1,
                 "Length": 38,
                 "Scale": null },
               { "Name": "Title",
                 "Type": 1,
                 "Length": 60,
                 "Scale": null },
               { "Name": "Artist",
                 "Type": 1,
                 "Length": 40,
                 "Scale": null },
               { "Name": "SortArtist",
                 "Type": 1,
                 "Length": 40,
                 "Scale": null },
               { "Name": "Year",
                 "Type": 3,
                 "Length": null,
                 "Scale": null },
               { "Name": "Label",
                 "Type": 1,
                 "Length": 40,
                 "Scale": null },
               { "Name": "CoverArt",
                 "Type": 8,
                 "Length": null,
                 "Scale": null },
               { "Name": "CoverArt_ContentType",
                 "Type": 1,
                 "Length": 40,
                 "Scale": null }]
}

HTTP Response: 200 on success or 500 on error

Get DataSet Parmeters Request

---

The get dataset parameters request enumerates all of the parameters in the dataset and database specified in the URL. The column information returned includes the name and type. The parameter types that can be returned are:


If there is no active session or the session is not authenticated, the request will result in a 403 Forbidden HTTP response.

HTTP Method: GET

HTTP Response Content Type: application/json; charset=utf-8

Example Request:

https://localhost/example/tracks/params

Example Response Content:

{
   "Params": [{ "Name": "AlbumID",
                "Type": 1 }]
}

HTTP Response: 200 on success or 500 on error

Get DataSet Rows Request

---

The get dataset rows request returns the rows in the dataset and database specified in the URL. Any input parameters to be used with the Select command for the dataset should be specified as URL parameters. Each column type in the JSON response content should be formatted according to the following rules:


If there is no active session or the session is not authenticated, the request will result in a 403 Forbidden HTTP response.

HTTP Method: GET

HTTP Response Content Type: application/json; charset=utf-8

Example Request:

https://localhost/example/albums/data?ID=0201c645-c8fe-46b0-b785-815a617a1136

Example Response Content:

{
   "Rows": [{ "ID": "0201c645-c8fe-46b0-b785-815a617a1136",
              "Title": "August and Everything After",
              "Artist": "Counting Crows",
              "SortArtist": "Counting Crows",
              "Year": 1993,
              "Label": "BMG Direct Marketing, Inc.",
              "CoverArt": "?column=CoverArt&ID=0201c645-c8fe-46b0-b785-815a617a1136",
              "CoverArt_ContentType": "image\/jpeg" }]
}

HTTP Response: 200 on success or 500 on error


Get DataSet BLOB Column Request

---

The get dataset BLOB column request returns the data in the column, dataset, and database specified in the URL. Unlike the database and dataset names, the BLOB column name is specified in a column parameter instead of in the URL. If there is no active session or the session is not authenticated, the request will result in a 403 Forbidden HTTP response.

HTTP Method: GET

HTTP Response Content Type: Determined by the <Column Name>_ContentType column, if present, and application/octet-stream if not

Example Request:

https://localhost/example/albums/data?column=CoverArt&ID=0201c645-c8fe-46b0-b785-815a617a1136

HTTP Response: 200 on success or 500 on error


Commit Database Transaction Request

---

The commit database transaction request commits a transaction for the database specified in the URL using the transaction operations in the included JSON content. The operation rowset IDs in the included JSON content are special internal identifiers used by client applications to update any generated row values using the response content (see below). The following are the operation types supported in the included JSON content, as well as how they affect the structure of the included JSON content:


The response to the commit database transaction request is a set of rows with a rowset ID, row ID, and row data, and will be used to update any inserted or updated rows in the client application with any newly-generated values that were created during the insert or update operation. For example, if an underlying table in the dataset contains an identity column that is assigned an identifier during row inserts, then the response content will contain the identifier.


If there is no active session or the session is not authenticated, the request will result in a 403 Forbidden HTTP response.

HTTP Method: POST

HTTP Request Content Type: application/json; charset=utf-8
HTTP Response Content Type: application/json; charset=utf-8

Example Request:

https://localhost/example

Example Request Content:

{
   "Operations": [{ "DataSet": "Orders",
                    "RowSet": 2,
                    "Operation": 2,
                    "BeforeRow": { "EWBRowID": 4,
                                   "OrderNo": 1006,
                                   "CustNo": 1380,
                                   "SaleDate": 1497398400000,
                                   "ShipDate": 594907200000,
                                   "EmpNo": 46,
                                   "ShipVIA": "Emery",
                                   "PO": "P101324",
                                   "Terms": "FOB",
                                   "PaymentMethod": "Visa",
                                   "ItemsTotal": 31987,
                                   "TaxRate": 0,
                                   "Freight": 0,
                                   "AmountPaid": 0 },
                    "AfterRow": { "EWBRowID": 4,
                                  "OrderNo": 1006,
                                  "CustNo": 1380,
                                  "SaleDate": 1497398400000,
                                  "ShipDate": 594907200000,
                                  "EmpNo": 110,
                                  "PO": "P101324",
                                  "Terms": "FOB",
                                  "PaymentMethod": "Visa",
                                  "ItemsTotal": 31987,
                                  "TaxRate": 0,
                                  "Freight": 0,
                                  "AmountPaid": 0 } }]
}

Example Response Content:

{
   "Rows": [{ "RowSet": 2,
              "EWBRowID": 4, 
              "Row": {  } }]

}

HTTP Response: 200 on success or 500 on error