">

Exciton Boost - RPC API

4.6.3

Remote Procedure Call API Reference - Database

This page describes the Database methods from Exciton Boost, including each method and property. To navigate between classes, use the table of contents on the left. To go directly to a method, use the table of contents on the right.

Database methods


db.addDocsWithJSON

Add documents based on a JSON object or array of objects.

Parameters

  • "source_Type": "string", A text string.
  • "source": "string", A text string.
  • "properties": "string", Property pairs such as attr='value' or JSON object representing the same properties. Optional.

Response

200 OK
"result": number, A number representing an unsigned long integer.

Request/Response Example

Request:POST /{dbpath}/api/boost/rpc
{
 "jsonrpc": "2.0",
 "method": "db.addDocsWithJSON",
 "params": 
   {
    "source_Type:": "Lorem ipsum dolor",
    "source:": "Duis aute irure",
    "properties:": "Spacing='yes' MaxCount=200"
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": 2042, "id": 1}

db.addViewWithJSON

Create a view based on a JSON object or array of objects.

Parameters

  • "viewName": "string", A text string.
  • "source_Type": "string", A text string.
  • "source": "string", A text string.
  • "properties": "string", Property pairs such as attr='value' or JSON object representing the same properties. Optional.

Response

200 OK
"result": true/false, A boolean result.

Request/Response Example

Request:POST /{dbpath}/api/boost/rpc
{
 "jsonrpc": "2.0",
 "method": "db.addViewWithJSON",
 "params": 
   {
    "viewName:": "Lorem ipsum dolor",
    "source_Type:": "Duis aute irure",
    "source:": "sint occaecat",
    "properties:": "Spacing='yes' MaxCount=200"
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": true, "id": 1}

db.calculateFromJSON

Perform calculations with an item value from a JSON object or array of objects.

Parameters

  • "sourceType": "string", A text string.
  • "source": "string", A text string.
  • "item": "string", A text string.
  • "sum": number, A number for an unsigned long integer.
  • "average": number, A number for an unsigned long integer.
  • "maximum": number, A number for an unsigned long integer.
  • "minimum": number, A number for an unsigned long integer.
  • "properties": "string", Property pairs such as attr='value' or JSON object representing the same properties. Optional.

Response

200 OK
"result": number, A number representing an unsigned long integer.

Request/Response Example

Request:POST /{dbpath}/api/boost/rpc
{
 "jsonrpc": "2.0",
 "method": "db.calculateFromJSON",
 "params": 
   {
    "sourceType:": "Lorem ipsum dolor",
    "source:": "Duis aute irure",
    "item:": "sint occaecat",
    "sum:": 0.025000,
    "average:": 2.025000,
    "maximum:": 4.025000,
    "minimum:": 6.025000
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": 2042, "id": 1}

db.updateWithJSON

Update documents from a JSON object or array of objects.

Parameters

  • "source_Type": "string", A text string.
  • "source": "string", A text string.
  • "properties": "string", Property pairs such as attr='value' or JSON object representing the same properties. Optional.

Response

204 No Content
As there is no return value, there should be no "id" included.

Request/Response Example

Request:POST /{dbpath}/api/boost/rpc
{
 "jsonrpc": "2.0",
 "method": "db.updateWithJSON",
 "params": 
   {
    "source_Type:": "ullamco laboris",
    "source:": "Ac turpis",
    "properties:": "Spacing='yes' MaxCount=200"
   }
}
Response:204 No Content

db.getDefaultForm / db.setDefaultForm

[Description to be added.]

Parameters (for db.setDefaultForm only)

  • "paramS": ["string"], A text value.

Response (for db.getDefaultForm only)

200 OK
"result": "string", A text value.

Request/Response Examples

Request:POST /{dbpath}/api/boost/rpc
{"jsonrpc": "2.0", "method": "db.getDefaultForm","id": 1}
Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}
Request:POST /{dbpath}/api/boost/rpc
{"jsonrpc": "2.0",
 "method": "db.setDefaultForm","params": "a text value"}
Response:204 No Content

db.getFilePath / db.setFilePath

[Description to be added.]

Parameters (for db.setFilePath only)

  • "paramS": ["string"], A text value.

Response (for db.getFilePath only)

200 OK
"result": "string", A text value.

Request/Response Examples

Request:POST /{dbpath}/api/boost/rpc
{"jsonrpc": "2.0", "method": "db.getFilePath","id": 1}
Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}
Request:POST /{dbpath}/api/boost/rpc
{"jsonrpc": "2.0",
 "method": "db.setFilePath","params": "a text value"}
Response:204 No Content

db.getServer / db.setServer

[Description to be added.]

Parameters (for db.setServer only)

  • "paramS": ["string"], A text value.

Response (for db.getServer only)

200 OK
"result": "string", A text value.

Request/Response Examples

Request:POST /{dbpath}/api/boost/rpc
{"jsonrpc": "2.0", "method": "db.getServer","id": 1}
Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}
Request:POST /{dbpath}/api/boost/rpc
{"jsonrpc": "2.0",
 "method": "db.setServer","params": "a text value"}
Response:204 No Content

db.getTitle / db.setTitle

[Description to be added.]

Parameters (for db.setTitle only)

  • "paramS": ["string"], A text value.

Response (for db.getTitle only)

200 OK
"result": "string", A text value.

Request/Response Examples

Request:POST /{dbpath}/api/boost/rpc
{"jsonrpc": "2.0", "method": "db.getTitle","id": 1}
Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}
Request:POST /{dbpath}/api/boost/rpc
{"jsonrpc": "2.0",
 "method": "db.setTitle","params": "a text value"}
Response:204 No Content