Remote Procedure Call API Reference - RTItem

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

Note: Rich text may be split into multiple items of the same name on a Notes document. When a rich text item name such as "Body" or "Summary" is specified for Exciton Boost, it refers to all the Notes items with that name on the document collectively. There is no need or ability to interact with the Notes items separately.

Additional JSON-RPC item for RTItem

"rtitem": "string" Rich text item name. (Optional)

POST /{dbpath}/api/boost/documents/{unid}/rpc
The "rtitem" will be used as the rich text item if specified, otherwise "Body" is assumed.

POST /{dbpath}/api/boost/documents/{unid}/rtitems/{itemname}/rpc
POST /{dbpath}/api/boost/documents/{unid}/rtitems/{itemname}/chunks/{chunkdef}/rpc
The "rtitem" will be ignored, as {itemname} is specified.

Request Example

Request:POST /{dbpath}/api/boost/documents/{unid}/rpc
{
 "jsonrpc": "2.0",
 "rtitem": "Summary",
 "method": "rti.appendFieldsWithJSON",
 "params": ["{...}", ""]
}

RTItem methods

rti.appendFieldsWithJSON

[Description to be added.]

Parameters

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

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.appendFieldsWithJSON",
 "params": 
   {
    "script:": "Lorem ipsum dolor",
    "properties:": "Spacing='yes' MaxCount=200",
    "col1Properties:": "Lorem ipsum dolor",
    "col2Properties:": "Duis aute irure"
   },
 "id": 1
}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

rti.clearStyleMappings

[Description to be added.]

Parameters

No "params" should be included.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.clearStyleMappings"
}

Response:204 No Content

rti.commit

[Description to be added.]

Parameters

No "params" should be included.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.commit"
}

Response:204 No Content

rti.connect

Connect to a specific rich text item by specifying server, db, note, and field information.

Parameters

• "server": "string", Domino server where a database resides, or "" for a local database.
• "filePath": "string", File pathname to database, often relative to data directory.
• "idStr": "string", Universal ID or Notes ID as a string. Assumed to be UNID if 32-byte hex string.
• "fieldname": "string", Name of the Notes item (defaults to 'Body' for rich text fields).
• "createFlag": true/false, A boolean value. Optional.
• "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/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.connect",
 "params": 
   {
    "server:": "Alibaba/Genii",
    "filePath:": "Orders.nsf",
    "idStr:": "938CF2B521B116234D6C082410F896D1",
    "fieldname:": "Description",
    "createFlag:": true
   }
}

Response:204 No Content

rti.connectBackend

Connect to a specific rich text item on an open note by specifying the note handle and field information.

Parameters

• "handle": double, Internal note handle representing an open note in memory.
• "fieldname": "string", Name of the Notes item (defaults to 'Body' for rich text fields).
• "createFlag": true/false, A boolean value. Optional.
• "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/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.connectBackend",
 "params": 
   {
    "handle:": 0,
    "fieldname:": "Body",
    "createFlag:": true,
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rti.connectCustomControl

Connect to the design note of a named custom control.

Parameters

• "server": "string", Domino server where a database resides, or "" for a local database.
• "filePath": "string", File pathname to database, often relative to data directory.
• "controlName": "string", A text string.
• "clonedName": "string", Name of the design element to clone. Optional.
• "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/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.connectCustomControl",
 "params": 
   {
    "server:": "Alibaba/Genii",
    "filePath:": "Orders.nsf",
    "controlName:": "Duis aute irure",
    "clonedName:": "StatusTemplate",
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rti.connectFileResource

Connect to the rich text of a named file resource.

Parameters

• "server": "string", Domino server where a database resides, or "" for a local database.
• "filePath": "string", File pathname to database, often relative to data directory.
• "resourceName": "string", A text string.
• "clonedName": "string", Name of the design element to clone. Optional.
• "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/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.connectFileResource",
 "params": 
   {
    "server:": "Alibaba/Genii",
    "filePath:": "Orders.nsf",
    "resourceName:": "Duis aute irure",
    "clonedName:": "StatusTemplate",
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rti.connectFormBody

Connect to the rich text design of a named form.

Parameters

• "server": "string", Domino server where a database resides, or "" for a local database.
• "filePath": "string", File pathname to database, often relative to data directory.
• "name": "string", Name of the design element.
• "clonedName": "string", Name of the design element to clone. Optional.
• "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/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.connectFormBody",
 "params": 
   {
    "server:": "Alibaba/Genii",
    "filePath:": "Orders.nsf",
    "name:": "LetterTemplate",
    "clonedName:": "StatusTemplate",
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rti.connectImageResource

Connect to the rich text of a named image resource.

Parameters

• "server": "string", Domino server where a database resides, or "" for a local database.
• "filePath": "string", File pathname to database, often relative to data directory.
• "imageName": "string", A text string.
• "clonedName": "string", Name of the design element to clone. Optional.
• "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/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.connectImageResource",
 "params": 
   {
    "server:": "Alibaba/Genii",
    "filePath:": "Orders.nsf",
    "imageName:": "Duis aute irure",
    "clonedName:": "StatusTemplate",
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rti.connectPageBody

Connect to the rich text design of a named page.

Parameters

• "server": "string", Domino server where a database resides, or "" for a local database.
• "filePath": "string", File pathname to database, often relative to data directory.
• "name": "string", Name of the design element.
• "clonedName": "string", Name of the design element to clone. Optional.
• "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/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.connectPageBody",
 "params": 
   {
    "server:": "Alibaba/Genii",
    "filePath:": "Orders.nsf",
    "name:": "LetterTemplate",
    "clonedName:": "StatusTemplate",
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rti.connectSharedField

Connect to the rich text of a named shared field.

Parameters

• "server": "string", Domino server where a database resides, or "" for a local database.
• "filePath": "string", File pathname to database, often relative to data directory.
• "fieldname": "string", Name of the Notes item (defaults to 'Body' for rich text fields).
• "clonedName": "string", Name of the design element to clone. Optional.
• "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/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.connectSharedField",
 "params": 
   {
    "server:": "Alibaba/Genii",
    "filePath:": "Orders.nsf",
    "fieldname:": "Comments",
    "clonedName:": "StatusTemplate",
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rti.connectSubformBody

Connect to the rich text design of a named subform.

Parameters

• "server": "string", Domino server where a database resides, or "" for a local database.
• "filePath": "string", File pathname to database, often relative to data directory.
• "name": "string", Name of the design element.
• "clonedName": "string", Name of the design element to clone. Optional.
• "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/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.connectSubformBody",
 "params": 
   {
    "server:": "Alibaba/Genii",
    "filePath:": "Orders.nsf",
    "name:": "LetterTemplate",
    "clonedName:": "StatusTemplate",
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rti.connectXPage

Connect to the design note of a named XPage.

Parameters

• "server": "string", Domino server where a database resides, or "" for a local database.
• "filePath": "string", File pathname to database, often relative to data directory.
• "xpageName": "string", A text string.
• "clonedName": "string", Name of the design element to clone. Optional.
• "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/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.connectXPage",
 "params": 
   {
    "server:": "Alibaba/Genii",
    "filePath:": "Orders.nsf",
    "xpageName:": "Duis aute irure",
    "clonedName:": "StatusTemplate",
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rti.copyBackend

[Description to be added.]

Parameters

• "handle": double, Internal note handle representing an open note in memory.
• "fieldname": "string", Name of the Notes item (defaults to 'Body' for rich text fields).
• "overwrite_Flag": true/false, A boolean value. 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/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.copyBackend",
 "params": 
   {
    "handle:": 5,
    "fieldname:": "Comments",
    "overwrite_Flag:": true
   }
}

Response:204 No Content

rti.create

Create and connect to a specific rich text item by specifying server, db, note, and field information.

Parameters

• "server": "string", Domino server where a database resides, or "" for a local database.
• "filePath": "string", File pathname to database, often relative to data directory.
• "idStr": "string", Universal ID or Notes ID as a string. Assumed to be UNID if 32-byte hex string.
• "fieldname": "string", Name of the Notes item (defaults to 'Body' for rich text fields).
• "overwrite_Flag": true/false, A boolean value. 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/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.create",
 "params": 
   {
    "server:": "Alibaba/Genii",
    "filePath:": "Orders.nsf",
    "idStr:": "938CF2B521B116234D6C082410F896D1",
    "fieldname:": "Description",
    "overwrite_Flag:": true
   }
}

Response:204 No Content

rti.createBackend

Create and connect to a specific rich text item on an open note by specifying the note handle and field information.

Parameters

• "handle": double, Internal note handle representing an open note in memory.
• "fieldname": "string", Name of the Notes item (defaults to 'Body' for rich text fields).
• "overwriteFlag": true/false, A boolean value. 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/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.createBackend",
 "params": 
   {
    "handle:": 10,
    "fieldname:": "Body",
    "overwriteFlag:": true
   }
}

Response:204 No Content

rti.defineChunk

Create a rich text chunk with a specified chunk definition.

Parameters

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

Response

200 OK
"result": ExcitonRTChunk, An ExcitonRTChunk class instance.

Request/Response Example

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.defineChunk",
 "params": 
   {
    "definition:": "After Section 2",
    "namedType:": "Duis aute irure"
   },
 "id": 1
}

Response:200 OK
{"jsonrpc": "2.0", "result": 1342, "id": 1}

rti.defineFont

Idientify the font face name so that it can be recognized when parsing font specifications for the rich text item and its related chunks.

Parameters

• "font_Name": "string", A text string.
• "family": "string", A text string. Optional.
• "pitch": "string", A text string. 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/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.defineFont",
 "params": 
   {
    "font_Name:": "sint occaecat",
    "family:": "ullamco laboris",
    "pitch:": "Ac turpis"
   }
}

Response:204 No Content

rti.getJSON

[Description to be added.]

Parameters

• "itemList": "string", Comma-separated list of items. Single asterisk includes all Notes items.
• "properties": "string", Property pairs such as attr='value' or JSON object representing the same properties. Optional.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.getJSON",
 "params": 
   {
    "itemList:": "Subject,Author",
    "properties:": "Spacing='yes' MaxCount=200"
   },
 "id": 1
}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

rti.jsonscript

[Description to be added.]

Parameters

• "script": "string", A text string.
• "saveOnFinish": true/false, A boolean value.
• "properties": "string", Property pairs such as attr='value' or JSON object representing the same properties. Optional.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.jsonscript",
 "params": 
   {
    "script:": "Lorem ipsum dolor",
    "saveOnFinish:": true,
    "properties:": "Spacing='yes' MaxCount=200"
   },
 "id": 1
}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

rti.linkMatching

[Description to be added.]

Parameters

• "server": "string", Domino server where a database resides, or "" for a local database.
• "filePath": "string", File pathname to database, often relative to data directory.
• "viewname": "string", A text string.
• "fieldname": "string", Name of the Notes item (defaults to 'Body' for rich text fields).
• "fieldname2": "string", Name of a second Notes item. Optional.
• "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/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.linkMatching",
 "params": 
   {
    "server:": "Alibaba/Genii",
    "filePath:": "Orders.nsf",
    "viewname:": "Duis aute irure",
    "fieldname:": "Body",
    "fieldname2:": "BriefDesc"
   }
}

Response:204 No Content

rti.renderNoteBackend

[Description to be added.]

Parameters

• "handle": double, Internal note handle representing an open note in memory.
• "formNameOverride": "string", A text string. Optional.
• "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/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.renderNoteBackend",
 "params": 
   {
    "handle:": 15,
    "formNameOverride:": "sint occaecat",
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rti.save

Save the in-memory note for the rich text item to disk, overwriting any existing on-disk representation of the entire note.

Parameters

• "allowMalformed": true/false, A boolean value. 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/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.save",
 "params": 
   {
    "allowMalformed:": true
   }
}

Response:204 No Content

rti.setFooter

Set the document footer value.

Parameters

• "text": "string", A text string.
• "font": "string", A text string. Optional.
• "fontName": "string", A text string. 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/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.setFooter",
 "params": 
   {
    "text:": "Lorem ipsum dolor",
    "font:": "Duis aute irure",
    "fontName:": "sint occaecat"
   }
}

Response:204 No Content

rti.setHeader

Set the document header value.

Parameters

• "text": "string", A text string.
• "font": "string", A text string. Optional.
• "fontName": "string", A text string. 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/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.setHeader",
 "params": 
   {
    "text:": "ullamco laboris",
    "font:": "Ac turpis",
    "fontName:": "Feugiat"
   }
}

Response:204 No Content

rti.suggestOutputFormat

[Description to be added.]

Parameters

• "goal": "string", A text string.
• "properties": "string", Property pairs such as attr='value' or JSON object representing the same properties.
• "defaultFormat": "string", A text string. 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/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.suggestOutputFormat",
 "params": 
   {
    "goal:": "Lorem ipsum dolor",
    "properties:": "Spacing='yes' MaxCount=200",
    "defaultFormat:": "Lorem ipsum dolor"
   }
}

Response:204 No Content

rti.unstoreForm

[Description to be added.]

Parameters

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

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.unstoreForm",
 "params": 
   {
    "properties:": "Spacing='yes' MaxCount=200"
   },
 "id": 1
}

Response:200 OK
{"jsonrpc": "2.0", "result": true, "id": 1}

rti.updateWithJSON

[Description to be added.]

Parameters

• "sourceType": "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/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rti.updateWithJSON",
 "params": 
   {
    "sourceType:": "Lorem ipsum dolor",
    "source:": "Duis aute irure",
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rti.getActionHotspotFont / rti.setActionHotspotFont

Read-write. The ActionHotspotFont property defines a font string to use when the software creates an Action Hotspot using the AppendHotspot method or the InsertHotspot method, both of the ExcitonRTChunk class. Defaults to 'Bold Green Underline'.

Parameters (for rti.setActionHotspotFont only)

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

Response (for rti.getActionHotspotFont only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getActionHotspotFont","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setActionHotspotFont","params": "a text value"}

Response:204 No Content

rti.getAutoDecrypt / rti.setAutoDecrypt

Read-write. If True (default), encrypted rich text fields will be decrypted automatically before connecting using the Connect method or other such methods. This is similar to the behavior in the Notes UI when the document is opened. If False, no automatic decrypting will happen, and the item will not connect to the encrypted field.

Parameters (for rti.setAutoDecrypt only)

• "paramS": [true/false]] A boolean result.

Response (for rti.getAutoDecrypt only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getAutoDecrypt","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": true, "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setAutoDecrypt","params": true}

Response:204 No Content

rti.getAutoMergeText / rti.setAutoMergeText

Read-write. If True (default), internal text records will be combined whenever their fonts and text attributes match. This is similar to the behavior in the Notes UI when the contents of the rich text field are cut and pasted again. If False, no automatic merging will take place, which will adversely effect the use of methods such as the Replace method. It is advised that this not be set to False unless specifically suggested by Genii Software personnel.

Parameters (for rti.setAutoMergeText only)

• "paramS": [true/false]] A boolean result.

Response (for rti.getAutoMergeText only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getAutoMergeText","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": true, "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setAutoMergeText","params": true}

Response:204 No Content

rti.getAutoSave / rti.setAutoSave

Read-write. If True, the document will be saved after every call that modifies the document. If False (default), no save will take effect until the Save method is called.

Parameters (for rti.setAutoSave only)

• "paramS": [true/false]] A boolean result.

Response (for rti.getAutoSave only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getAutoSave","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": true, "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setAutoSave","params": true}

Response:204 No Content

rti.getCacheLinkMatching / rti.setCacheLinkMatching

Read-write. If True (default), previous search results for any of the methods using the SmartRefs methods (AppendMatching method, HighlightMatching method, etc., including the original LinkMatching method) will be saved in the ExcitonSession context to speed up subsequent calls. If set to False, those search results will be discarded after every call. Leaving this property as True is highly recommended in most cases when the SmartRefs methods are being used.

Parameters (for rti.setCacheLinkMatching only)

• "paramS": [true/false]] A boolean result.

Response (for rti.getCacheLinkMatching only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getCacheLinkMatching","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": true, "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setCacheLinkMatching","params": true}

Response:204 No Content

rti.getCacheRecords / rti.setCacheRecords

Read-write. If False (default), internal records will be saved to the in memory image of the note after each change to the rich text. This was the only possible behavior prior to Version 2.10. If set to True, these internal records will be saved and re-used and must be saved to the in memory image of the note by the Save method. Setting this property to True is recommended in most cases, and can mean a huge performance gain, but does mean that in cases where the ConnectBackend method or CreateBackend method is used to connect to a NotesDocument object, either the Commit method or the Save method of the ExcitonRTItem class must be used before or instead of the NotesDocument.Save. (The Commit method does not perform a save, but does flush the internal records to the in memory image.)

Parameters (for rti.setCacheRecords only)

• "paramS": [true/false]] A boolean result.

Response (for rti.getCacheRecords only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getCacheRecords","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": true, "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setCacheRecords","params": true}

Response:204 No Content

rti.getClientPreference / rti.setClientPreference

Read-write. The ClientPreference property is used to determine what color names are used when setting font specifications and such. Because a different set of names are generally used on the web ('web') than in the Notes client ('Notes' - default), two different set of specifications are used.

Parameters (for rti.setClientPreference only)

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

Response (for rti.getClientPreference only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getClientPreference","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setClientPreference","params": "a text value"}

Response:204 No Content

rti.getContainerType

[Description to be added.]

Parameters

No "params" should be included.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getContainerType","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": 22, "id": 1}

Response:204 No Content

rti.getDefaultFormName / rti.setDefaultFormName

[Description to be added.]

Parameters (for rti.setDefaultFormName only)

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

Response (for rti.getDefaultFormName only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getDefaultFormName","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setDefaultFormName","params": "a text value"}

Response:204 No Content

rti.getDefaultTableWidth / rti.setDefaultTableWidth

Read-write. When a table is created programmatically, this values determines the default width of the table. This is important even if the table is created as Fit to Window, because it determines the default size should somenone choose to make it a fixed width table later on.The default is 7.5 inches.

Parameters (for rti.setDefaultTableWidth only)

• "paramS": [number], A number representing a floating point double.

Response (for rti.getDefaultTableWidth only)

200 OK
"result": number, A number representing a floating point double.

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getDefaultTableWidth","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": 6.37, "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setDefaultTableWidth","params": 6.37}

Response:204 No Content

rti.getEverything / rti.setEverything

Read-write. The Everything property is a special ExcitonRTChunk object which is automatically defined as 'Everything'. It is instantiated when needed, and is used largely as a shortcut to avoid needing a separate ExcitonRTChunk when acting on the whole field.

Parameters (for rti.setEverything only)

• "paramS": [ExcitonRTChunk], An ExcitonRTChunk class instance.

Response (for rti.getEverything only)

200 OK
"result": ExcitonRTChunk, An ExcitonRTChunk class instance.

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getEverything","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": 1342, "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setEverything","params": 1342}

Response:204 No Content

rti.getFieldName

Read-only. The FieldName property defines the field name for the connected rich text item itself.

Parameters

No "params" should be included.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getFieldName","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Response:204 No Content

rti.getFilePath

Read-only. The FilePath property defines what the pathname of the database the rich text item is on.

Parameters

No "params" should be included.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getFilePath","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Response:204 No Content

rti.getFontFaces

Read-only. The FontFaces property defines the array of font faces available for use in font definition strings. This represents the fonts found in $Fonts as well as the five standard font faces, Swiss, Helv, Roman, Courier and Static. This property may be used to select a font face which is sure to be available, or to determine if a font face should be added using the DefineFont method.

Parameters

No "params" should be included.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getFontFaces","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Response:204 No Content

rti.getForceToWindow / rti.setForceToWindow

Read-write. If False (default), tables will be left alone. If set to True, all tables in the ExcitonRTItem will be set to fit to window. This is an obsolete property, since it is better to set the table properties using the ChangeTable method in the ExcitonRTChunk class.

Parameters (for rti.setForceToWindow only)

• "paramS": [true/false]] A boolean result.

Response (for rti.getForceToWindow only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getForceToWindow","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": true, "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setForceToWindow","params": true}

Response:204 No Content

rti.getFormName / rti.setFormName

[Description to be added.]

Parameters (for rti.setFormName only)

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

Response (for rti.getFormName only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getFormName","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setFormName","params": "a text value"}

Response:204 No Content

rti.getHTMLBodyAttributes / rti.setHTMLBodyAttributes

Read-write. The HTMLBodyAttributes property refers to the formula on the design note which determines content to be added to the HTML Body tag, when the document is rendered to a web browser. Equivalent to the HTMLBodyAttributes agent shown in the form design.

Parameters (for rti.setHTMLBodyAttributes only)

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

Response (for rti.getHTMLBodyAttributes only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getHTMLBodyAttributes","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setHTMLBodyAttributes","params": "a text value"}

Response:204 No Content

rti.getHTMLHeadContent / rti.setHTMLHeadContent

[Description to be added.]

Parameters (for rti.setHTMLHeadContent only)

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

Response (for rti.getHTMLHeadContent only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getHTMLHeadContent","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setHTMLHeadContent","params": "a text value"}

Response:204 No Content

rti.getHandle

Read-only. This is the internal notehandle for the copy of the document in memory when an ExcitonRTItem object is connected. It is used in the ConnectBackend method, the CreateBackend method and the CopyBackend method to allow two rich text fields to use the same internal document in memory (thus avoiding save conflicts). There is a similar Handle property on the NotesDocument class in Notes 4.6x and beyond which allows the ExcitonRTItem object to use the same internal document as the NotesDocument class object uses.

Parameters

No "params" should be included.

Response

200 OK
"result": note-handle, A long integer representing a Notes document handle.

Request/Response Example

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getHandle","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": 134, "id": 1}

Response:204 No Content

rti.getHighlightFont / rti.setHighlightFont

Read-write. The HighlightFont property defines a font to use with the the software Highlight feature. A number of methods in the ExcitonRTChunk class including the Highlight method, the HighlightMatching method, the HighlightText method and the RegexHighlight method, use this property to determine the text style of any appropriate text. Defaults to 'RED +BOLD'.

Parameters (for rti.setHighlightFont only)

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

Response (for rti.getHighlightFont only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getHighlightFont","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setHighlightFont","params": "a text value"}

Response:204 No Content

rti.getHyperLinkFont / rti.setHyperLinkFont

[Description to be added.]

Parameters (for rti.setHyperLinkFont only)

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

Response (for rti.getHyperLinkFont only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getHyperLinkFont","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setHyperLinkFont","params": "a text value"}

Response:204 No Content

rti.getImportExportFile / rti.setImportExportFile

[Description to be added.]

Parameters (for rti.setImportExportFile only)

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

Response (for rti.getImportExportFile only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getImportExportFile","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setImportExportFile","params": "a text value"}

Response:204 No Content

rti.getImportNativeImages / rti.setImportNativeImages

[Description to be added.]

Parameters (for rti.setImportNativeImages only)

• "paramS": [true/false]] A boolean result.

Response (for rti.getImportNativeImages only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getImportNativeImages","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": true, "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setImportNativeImages","params": true}

Response:204 No Content

rti.getIsConnected

[Description to be added.]

Parameters

No "params" should be included.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getIsConnected","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": true, "id": 1}

Response:204 No Content

rti.getModified / rti.setModified

[Description to be added.]

Parameters (for rti.setModified only)

• "paramS": [true/false]] A boolean result.

Response (for rti.getModified only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getModified","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": true, "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setModified","params": true}

Response:204 No Content

rti.getNoteID

[Description to be added.]

Parameters

No "params" should be included.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getNoteID","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Response:204 No Content

rti.getPermanentPen / rti.setPermanentPen

[Description to be added.]

Parameters (for rti.setPermanentPen only)

• "paramS": [true/false]] A boolean result.

Response (for rti.getPermanentPen only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getPermanentPen","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": true, "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setPermanentPen","params": true}

Response:204 No Content

rti.getPermanentPenFont / rti.setPermanentPenFont

[Description to be added.]

Parameters (for rti.setPermanentPenFont only)

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

Response (for rti.getPermanentPenFont only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getPermanentPenFont","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setPermanentPenFont","params": "a text value"}

Response:204 No Content

rti.getPopUpFont / rti.setPopUpFont

[Description to be added.]

Parameters (for rti.setPopUpFont only)

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

Response (for rti.getPopUpFont only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getPopUpFont","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setPopUpFont","params": "a text value"}

Response:204 No Content

rti.getRTFields

[Description to be added.]

Parameters

No "params" should be included.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getRTFields","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Response:204 No Content

rti.getServer

[Description to be added.]

Parameters

No "params" should be included.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getServer","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Response:204 No Content

rti.getSuppressMessages / rti.setSuppressMessages

[Description to be added.]

Parameters (for rti.setSuppressMessages only)

• "paramS": [true/false]] A boolean result.

Response (for rti.getSuppressMessages only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getSuppressMessages","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": true, "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setSuppressMessages","params": true}

Response:204 No Content

rti.getTheme / rti.setTheme

[Description to be added.]

Parameters (for rti.setTheme only)

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

Response (for rti.getTheme only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getTheme","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setTheme","params": "a text value"}

Response:204 No Content

rti.getURLFont / rti.setURLFont

[Description to be added.]

Parameters (for rti.setURLFont only)

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

Response (for rti.getURLFont only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getURLFont","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setURLFont","params": "a text value"}

Response:204 No Content

rti.getWebQueryOpen / rti.setWebQueryOpen

[Description to be added.]

Parameters (for rti.setWebQueryOpen only)

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

Response (for rti.getWebQueryOpen only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getWebQueryOpen","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setWebQueryOpen","params": "a text value"}

Response:204 No Content

rti.getWebQuerySave / rti.setWebQuerySave

[Description to be added.]

Parameters (for rti.setWebQuerySave only)

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

Response (for rti.getWebQuerySave only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getWebQuerySave","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setWebQuerySave","params": "a text value"}

Response:204 No Content

rti.getWindowTitle / rti.setWindowTitle

[Description to be added.]

Parameters (for rti.setWindowTitle only)

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

Response (for rti.getWindowTitle only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rti.getWindowTitle","id": 1}

Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rti.setWindowTitle","params": "a text value"}

Response:204 No Content