">

Exciton Boost - RPC API

4.6.3

Remote Procedure Call API Reference - Document

This page describes the Document 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.

Document methods


doc.addToFolder

[Description to be added.]

Parameters

  • "folder": "string", A text string.

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": "doc.addToFolder",
 "params": 
   {
    "folder:": "Lorem ipsum dolor"
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": 2042, "id": 1}

doc.connectRTItem

[Description to be added.]

Parameters

  • "fieldname": "string", Name of the Notes item (defaults to 'Body' for rich text fields).
  • "createFlag": true/false, A boolean value. 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": "doc.connectRTItem",
 "params": 
   {
    "fieldname:": "Comments",
    "createFlag:": true
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": 2042, "id": 1}

doc.defineRTChunk

[Description to be added.]

Parameters

  • "definition": "string", Definition of the rich text chunk, e.g., 'Table 2' or 'After Section 1'.

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": "doc.defineRTChunk",
 "params": 
   {
    "definition:": "Table 1"
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": 2042, "id": 1}

doc.removeFromFolder

[Description to be added.]

Parameters

  • "folder": "string", A text string.

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": "doc.removeFromFolder",
 "params": 
   {
    "folder:": "Lorem ipsum dolor"
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": 2042, "id": 1}

doc.runAgent

[Description to be added.]

Parameters

  • "agent": "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": "doc.runAgent",
 "params": 
   {
    "agent:": "Duis aute irure",
    "properties:": "Spacing='yes' MaxCount=200"
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": 2042, "id": 1}

doc.getAuthors / doc.setAuthors

[Description to be added.]

Parameters (for doc.setAuthors only)

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

Response (for doc.getAuthors only)

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

Request/Response Examples

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

doc.getReaders / doc.setReaders

[Description to be added.]

Parameters (for doc.setReaders only)

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

Response (for doc.getReaders only)

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

Request/Response Examples

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