Remote Procedure Call API Reference - RTChunk

This page describes the RTChunk 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 items for RTChunk

"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.

"subdef": "string" Chunk definition relative to current chunk. (Optional)

POST /{dbpath}/api/boost/documents/{unid}/rpc
POST /{dbpath}/api/boost/documents/{unid}/rtitems/{itemname}/rpc
The "subdef" will be used as the chunk definition, as there is no chunk to be relative to.

POST /{dbpath}/api/boost/documents/{unid}/rtitems/{itemname}/chunks/{chunkdef}/rpc
The "subdef" will be relative to the {chunkdef} specified.

Request Example

Request:POST /{dbpath}/api/boost/documents/{unid}/rpc
{
 "jsonrpc": "2.0",
 "rtitem": "Description",
 "subdef": "After Table 1",
 "method": "rtc.appendText",
 "params": ["Text to add after table", "Bold 12pt"]
}

RTChunk methods

rtc.appendAnchor

Appends an anchor (target for an anchor link) into the chunk after the end of the chunk. When the rich text field is projected in Domino, this becomes an anchor tag.

Parameters

• "anchorText": "string", String to use as anchor in either HTML or rich text on a document or form.

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": "rtc.appendAnchor",
 "params": 
   {
    "anchorText:": "beginning"
   }
}

Response:204 No Content

rtc.appendField

Appends a new field in a form after the end of a rich text chunk. (Note: If the chunk is defined as Inside, this usually appends inside the target) If the field name is a duplicate of an existing field, the field name will be changed to be unique.

Parameters

• "fieldname": "string", Name of the Notes item (defaults to 'Body' for rich text fields).
• "fieldType": "string", A text string. Optional.
• "editType": "string", A text string. Optional.
• "defaultFormula": "string", A text string. Optional.
• "inputTranslation": "string", A text string. Optional.
• "inputValidation": "string", A text string. Optional.
• "fontSpecs": "string", Loose description of text attributes, color, font face, and/or size. Optional.
• "choices": "string", A text string. Optional.
• "description": "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": "rtc.appendField",
 "params": 
   {
    "fieldname:": "Comments",
    "fieldType:": "sint occaecat",
    "editType:": "ullamco laboris",
    "defaultFormula:": "Ac turpis",
    "inputTranslation:": "Feugiat"
   }
}

Response:204 No Content

rtc.appendFieldsWithJSON

[Description to be added.]

Parameters

• "jsondef": "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": "rtc.appendFieldsWithJSON",
 "params": 
   {
    "jsondef:": "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}

rtc.appendFileAttachment

[Description to be added.]

Parameters

• "pathname": "string", Pathname to the file, resource, or directory.
• "displayFileName": "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": "rtc.appendFileAttachment",
 "params": 
   {
    "pathname:": "Lorem ipsum dolor",
    "displayFileName:": "Duis aute irure",
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rtc.appendFormBody

[Description to be added.]

Parameters

• "name": "string", Name of the design element.

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": "rtc.appendFormBody",
 "params": 
   {
    "name:": "LetterTemplate"
   }
}

Response:204 No Content

rtc.appendHotspot

[Description to be added.]

Parameters

• "hotspotType": "string", A text string.
• "value": "string", A text string.
• "properties": "string", Property pairs such as attr='value' or JSON object representing the same properties. Optional.
• "title": "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": "rtc.appendHotspot",
 "params": 
   {
    "hotspotType:": "Lorem ipsum dolor",
    "value:": "Duis aute irure",
    "properties:": "Spacing='yes' MaxCount=200",
    "title:": "Lorem ipsum dolor"
   }
}

Response:204 No Content

rtc.appendImportFile

Appends an external file into the chunk at the end of the chunk. Imports based on the extension, unless an alternate doctype is specified.

Parameters

• "pathname": "string", Pathname to the file, resource, or directory.
• "docTypeOverride": "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": "rtc.appendImportFile",
 "params": 
   {
    "pathname:": "Lorem ipsum dolor",
    "docTypeOverride:": "Duis aute irure"
   }
}

Response:204 No Content

rtc.appendLayer

[Description to be added.]

Parameters

• "top": "string", A text string.
• "left": "string", A text string.
• "height": "string", A text string.
• "width": "string", A text string.
• "zindex": num, A number for an unsigned short integer.
• "properties": "string", Property pairs such as attr='value' or JSON object representing the same properties. Optional.
• "paragraphStyle": "string", A text string. Optional.
• "hideFormula": "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": "rtc.appendLayer",
 "params": 
   {
    "top:": "sint occaecat",
    "left:": "ullamco laboris",
    "height:": "Ac turpis",
    "width:": "Feugiat",
    "zindex:": 0
   }
}

Response:204 No Content

rtc.appendLink

Appends a link into the chunk at the end of the chunk. This may be a doclink, hyperlink (also known as a link hotspot), or a URL link. Doclinks and hyperlinks may be anchor links, document links, view links or db links, depending on how much information is specified.

Parameters

• "hyperlinkText": "string", A text string.
• "repIdOrURL": "string", Either a replica id or a URL.
• "viewUNID": "string", Universal ID of a view or folder as a 32-byte hex string. Optional.
• "noteUNID": "string", Universal ID of a note as a 32-byte hex string. Optional.
• "popupText": "string", Popup text to display on mouseover of a link. Optional.
• "serverHint": "string", Domino server to use for resolving doclink if no local replica. "" means there is no server hint. Optional.
• "anchorText": "string", String to use as anchor in either HTML or rich text on a document or form. 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": "rtc.appendLink",
 "params": 
   {
    "hyperlinkText:": "Lorem ipsum dolor",
    "repIdOrURL:": "http://geniisoft.com",
    "viewUNID:": "73C0525659500609669E8E5F799D3696",
    "noteUNID:": "9E8E5F799D36973C0525659500609666",
    "popupText:": "C API Notes/Domino 9.0.1 Reference"
   }
}

Response:204 No Content

rtc.appendNewLines

Appends one or more new lines after the end of a rich text chunk, as well as an optional paragraph break.

Parameters

• "count": num, A number for an unsigned short integer.
• "newParagraph": 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": "rtc.appendNewLines",
 "params": 
   {
    "count:": 5,
    "newParagraph:": true
   }
}

Response:204 No Content

rtc.appendPageBody

[Description to be added.]

Parameters

• "name": "string", Name of the design element.

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": "rtc.appendPageBody",
 "params": 
   {
    "name:": "LetterTemplate"
   }
}

Response:204 No Content

rtc.appendPageBreak

[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": "rtc.appendPageBreak"
}

Response:204 No Content

rtc.appendParagraph

Appends a new paragraph after the current chunk. (Note: If the scope of the chunk is defined as Inside, this usually appends inside the target)

Parameters

• "paragraphStyle": "string", A text string.
• "fontSpecs": "string", Loose description of text attributes, color, font face, and/or size. Optional.
• "hideFormula": "string", A text string. Optional.

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": "rtc.appendParagraph",
 "params": 
   {
    "paragraphStyle:": "Lorem ipsum dolor",
    "fontSpecs:": "-Bold 10pt",
    "hideFormula:": "sint occaecat"
   },
 "id": 1
}

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

rtc.appendRTChunk

Appends the contents of the designated rich text chunk into the current rich text chunk.

Parameters

• "chunk": ExcitonRTChunk A class instance object.
• "respectParagraphStyles": 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": "rtc.appendRTChunk",
 "params": 
   {
    "chunk:": sampleParam1,
    "respectParagraphStyles:": true
   }
}

Response:204 No Content

rtc.appendRTItem

Appends the contents of the designated rich text item into the current rich text chunk.

Parameters

• "serverOrRTItem": ExcitonRTItem A class instance object.
• "filePath": "string", File pathname to database, often relative to data directory. Optional.
• "noteID": "string", A text string. Optional.
• "fieldname": "string", Name of the Notes item (defaults to 'Body' for rich text fields). 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": "rtc.appendRTItem",
 "params": 
   {
    "serverOrRTItem:": sampleParam1,
    "filePath:": "Sample.nsf",
    "noteID:": "Lorem ipsum dolor",
    "fieldname:": "Comments"
   }
}

Response:204 No Content

rtc.appendRenderedNote

[Description to be added.]

Parameters

• "handle": double, Internal note handle representing an open note in memory.
• "renderWithForm": "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": "rtc.appendRenderedNote",
 "params": 
   {
    "handle:": 10,
    "renderWithForm:": "Lorem ipsum dolor",
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rtc.appendResource

[Description to be added.]

Parameters

• "resourceType": "string", A text string.
• "resourceName": "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": "rtc.appendResource",
 "params": 
   {
    "resourceType:": "Lorem ipsum dolor",
    "resourceName:": "Duis aute irure",
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rtc.appendRow

Appends a copy of the current row below the current row in a table. The chunk must be defined as either an entire table or a row in a table. If the chunk is defined as an entire table, the row copied will be the first row and it will be appended at the end of the table. The AppendRow method will fail if any cells in the row to be copied are merged with cells above or below, but it is legitimate to copy a row in which cells are merged horizontally.

Parameters

• "copyContents": true/false, A boolean value. Optional.
• "rowToCopy": num, A number for an unsigned short integer. Optional.
• "col1": "string", A text string. Optional.
• "col2": "string", A text string. Optional.
• "col3": "string", A text string. Optional.
• "col4": "string", A text string. Optional.
• "col5": "string", A text string. Optional.
• "col6": "string", A text string. Optional.
• "col7": "string", A text string. Optional.
• "col8": "string", A text string. Optional.
• "col9": "string", A text string. Optional.
• "col10": "string", A text string. Optional.
• "col11": "string", A text string. Optional.
• "col12": "string", A text string. Optional.
• "col13": "string", A text string. Optional.
• "col14": "string", A text string. Optional.
• "col15": "string", A text string. Optional.
• "col16": "string", A text string. Optional.
• "col17": "string", A text string. Optional.
• "col18": "string", A text string. Optional.
• "col19": "string", A text string. Optional.
• "col20": "string", A text string. Optional.

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": "rtc.appendRow",
 "params": 
   {
    "copyContents:": true,
    "rowToCopy:": 15,
    "col1:": "Lorem ipsum dolor",
    "col2:": "Duis aute irure",
    "col3:": "sint occaecat"
   },
 "id": 1
}

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

rtc.appendSubformBody

Appends the rich text field $Body from the named subform in the same database as the ExcitonRTItem parent for the defined chunk. (Note: If the chunk is defined as Inside, this usually appends inside the target) This is a specialized method that allows designers to set up subforms as design templates for segments of a rich text field. These design templates or elements are thus protected from non-designers and are easily accessible to scripts that build a document from component pieces.

Parameters

• "name": "string", Name of the design element.

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": "rtc.appendSubformBody",
 "params": 
   {
    "name:": "LetterTemplate"
   }
}

Response:204 No Content

rtc.appendTable

Appends a new table after the end of a rich text chunk.

Parameters

• "rowCount": num, A number for an unsigned short integer.
• "columnCount": num, A number for an unsigned short integer.
• "tableProperties": "string", A text string. Optional.
• "col1": "string", A text string. Optional.
• "col2": "string", A text string. Optional.
• "col3": "string", A text string. Optional.
• "col4": "string", A text string. Optional.
• "col5": "string", A text string. Optional.
• "col6": "string", A text string. Optional.
• "col7": "string", A text string. Optional.
• "col8": "string", A text string. Optional.
• "col9": "string", A text string. Optional.
• "col10": "string", A text string. Optional.
• "col11": "string", A text string. Optional.
• "col12": "string", A text string. Optional.
• "col13": "string", A text string. Optional.
• "col14": "string", A text string. Optional.
• "col15": "string", A text string. Optional.
• "col16": "string", A text string. Optional.
• "col17": "string", A text string. Optional.
• "col18": "string", A text string. Optional.
• "col19": "string", A text string. Optional.
• "col20": "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": "rtc.appendTable",
 "params": 
   {
    "rowCount:": 20,
    "columnCount:": 4,
    "tableProperties:": sampleParam3,
    "col1:": sampleParam4,
    "col2:": sampleParam5
   }
}

Response:204 No Content

rtc.appendTabs

Appends one or more tabs after the end of a rich text chunk.

Parameters

• "count": num, A number for an unsigned short integer.

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": "rtc.appendTabs",
 "params": 
   {
    "count:": 9
   }
}

Response:204 No Content

rtc.appendText

Appends a text string after the current chunk. If a format is not epscified, it will use the current format at the end of the chunk.

Parameters

• "text": "string", A text string in UTF8 format.
• "fontSpecs": "string", Loose description of text attributes, color, font face, and/or size. 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": "rtc.appendText",
 "params": 
   {
    "text:": "unde omnis",
    "fontSpecs:": "-Bold 10pt"
   }
}

Response:204 No Content

rtc.changeDoclinks

Modify links of all sorts.

Parameters

• "replicaID": "string", Replica id for a Notes database as a 16-byte hex string.
• "viewUNID": "string", Universal ID of a view or folder as a 32-byte hex string. Optional.
• "noteUNID": "string", Universal ID of a note as a 32-byte hex string. Optional.
• "popupText": "string", Popup text to display on mouseover of a link. Optional.
• "serverHint": "string", Domino server to use for resolving doclink if no local replica. "" means there is no server hint. Optional.
• "matchReplicaID": "string", A text string. Optional.
• "matchViewUNID": "string", A text string. Optional.
• "matchNoteUNID": "string", A text string. Optional.
• "matchPopupText": "string", A text string. Optional.
• "matchHintServer": "string", A text string. Optional.
• "anchorText": "string", String to use as anchor in either HTML or rich text on a document or form. Optional.
• "matchAnchorText": "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": "rtc.changeDoclinks",
 "params": 
   {
    "replicaID:": "16386F1C6C08738",
    "viewUNID:": "1F163861C6C938CF2897D2B52087380F",
    "noteUNID:": "938CF2B521F163861C6C087380F897D2",
    "popupText:": "C API Notes/Domino 9.0.1 Reference",
    "serverHint:": "Alibaba/Genii"
   }
}

Response:204 No Content

rtc.changeFont

Modify the font in the current chunk.

Parameters

• "fontSpecs": "string", Loose description of text attributes, color, font face, and/or size.
• "matchFontSpecs": "string", A text string. Optional.
• "includeNonTextFlag": 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": "rtc.changeFont",
 "params": 
   {
    "fontSpecs:": "Plain",
    "matchFontSpecs:": "Duis aute irure",
    "includeNonTextFlag:": true
   }
}

Response:204 No Content

rtc.changeParagraph

Modify the paragraph settings, including margins, tabs and alignment.

Parameters

• "paragraphSpecs": "string", A text string.
• "matchParagraphSpecs": "string", A text string. Optional.
• "forceSetFlag": 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": "rtc.changeParagraph",
 "params": 
   {
    "paragraphSpecs:": "sint occaecat",
    "matchParagraphSpecs:": "ullamco laboris",
    "forceSetFlag:": true
   }
}

Response:204 No Content

rtc.changeTable

Modify the table properties in the current chunk.

Parameters

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

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": "rtc.changeTable",
 "params": 
   {
    "tableProperties:": "Ac turpis"
   }
}

Response:204 No Content

rtc.convertBitmaps

[Description to be added.]

Parameters

• "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": "rtc.convertBitmaps",
 "params": 
   {
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rtc.defineChunk

[Description to be added.]

Parameters

• "rtitem": ExcitonRTItem A class instance object.
• "definition": "string", Definition of the rich text chunk, e.g., 'Table 2' or 'After Section 1'.

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": "rtc.defineChunk",
 "params": 
   {
    "rtitem:": sampleParam1,
    "definition:": "After Section 2"
   },
 "id": 1
}

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

rtc.defineSubChunk

[Description to be added.]

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": "rtc.defineSubChunk",
 "params": 
   {
    "definition:": "Everything",
    "namedType:": "sint occaecat"
   },
 "id": 1
}

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

rtc.exportGraphic

[Description to be added.]

Parameters

• "pathname": "string", Pathname to the file, resource, or directory.
• "formatOverride": "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": "rtc.exportGraphic",
 "params": 
   {
    "pathname:": "Lorem ipsum dolor",
    "formatOverride:": "Duis aute irure"
   },
 "id": 1
}

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

rtc.fixupGraphics

[Description to be added.]

Parameters

• "mode": num, A number for an unsigned short 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 short integer.

Request/Response Example

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

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

rtc.fontInUse

[Description to be added.]

Parameters

• "fontSpecs": "string", Loose description of text attributes, color, font face, and/or size.

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": "rtc.fontInUse",
 "params": 
   {
    "fontSpecs:": "Plain"
   },
 "id": 1
}

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

rtc.generateHTML

[Description to be added.]

Parameters

• "definition": "string", Definition of the rich text chunk, e.g., 'Table 2' or 'After Section 1'. Optional.
• "htmltype": "string", HTML type, usually either HTML or XHTML Optional.
• "properties": "string", Property pairs such as attr='value' or JSON object representing the same properties. Optional.
• "reserved1": "string", A text string. Optional.
• "reserved2": number, A number for an unsigned long integer. 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": "rtc.generateHTML",
 "params": 
   {
    "definition:": "Everything",
    "htmltype:": "HTML",
    "properties:": "Spacing='yes' MaxCount=200",
    "reserved1:": "Lorem ipsum dolor",
    "reserved2:": sampleParam5
   },
 "id": 1
}

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

rtc.getCellBorder

[Description to be added.]

Parameters

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

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rtc.getCellBorder",
 "params": 
   {
    "borderEdge:": "Duis aute irure"
   },
 "id": 1
}

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

rtc.getCount

[Description to be added.]

Parameters

• "targetType": "string", One of the valid types of targets for rich text chunks, such as 'Table', 'Hotspot', 'Field'.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rtc.getCount",
 "params": 
   {
    "targetType:": "Hotspot"
   },
 "id": 1
}

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

rtc.getHTMLValue

[Description to be added.]

Parameters

• "tagname": "string", A text string.
• "targetType": "string", One of the valid types of targets for rich text chunks, such as 'Table', 'Hotspot', 'Field'. 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": "rtc.getHTMLValue",
 "params": 
   {
    "tagname:": "ullamco laboris",
    "targetType:": "Table"
   },
 "id": 1
}

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

rtc.getLastTarget

[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": "rtc.getLastTarget",
 "id": 1
}

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

rtc.getNextTarget

[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": "rtc.getNextTarget",
 "id": 1
}

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

rtc.getPreviousTarget

[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": "rtc.getPreviousTarget",
 "id": 1
}

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

rtc.getTableProperties

[Description to be added.]

Parameters

• "propertyName": "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": "rtc.getTableProperties",
 "params": 
   {
    "propertyName:": "Lorem ipsum dolor"
   },
 "id": 1
}

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

rtc.getTargetProperties

[Description to be added.]

Parameters

• "targetType": "string", One of the valid types of targets for rich text chunks, such as 'Table', 'Hotspot', 'Field'.
• "propertyName": "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": "rtc.getTargetProperties",
 "params": 
   {
    "targetType:": "NonBlankText",
    "propertyName:": "sint occaecat"
   },
 "id": 1
}

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

rtc.highlight

[Description to be added.]

Parameters

• "includeNonText": 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": "rtc.highlight",
 "params": 
   {
    "includeNonText:": true
   }
}

Response:204 No Content

rtc.highlightMatching

[Description to be added.]

Parameters

• "server": "string", Domino server where a database resides, or "" for a local database. Optional.
• "filePath": "string", File pathname to database, often relative to data directory.
• "viewName": "string", Name of a view or folder. May be main view name or an alias.
• "fieldname": "string", Name of the Notes item (defaults to 'Body' for rich text fields).
• "reserved": "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": "rtc.highlightMatching",
 "params": 
   {
    "server:": "Alibaba/Genii",
    "filePath:": "Orders.nsf",
    "viewName:": "By Date",
    "fieldname:": "Body",
    "reserved:": "Lorem ipsum dolor"
   }
}

Response:204 No Content

rtc.highlightText

[Description to be added.]

Parameters

• "text": "string", A text string in UTF8 format.

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": "rtc.highlightText",
 "params": 
   {
    "text:": "iste natus error"
   }
}

Response:204 No Content

rtc.insertAnchor

[Description to be added.]

Parameters

• "anchorText": "string", String to use as anchor in either HTML or rich text on a document or form.

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": "rtc.insertAnchor",
 "params": 
   {
    "anchorText:": "top-related"
   }
}

Response:204 No Content

rtc.insertField

[Description to be added.]

Parameters

• "fieldname": "string", Name of the Notes item (defaults to 'Body' for rich text fields).
• "fieldType": "string", A text string. Optional.
• "editType": "string", A text string. Optional.
• "defaultFormula": "string", A text string. Optional.
• "inputTranslation": "string", A text string. Optional.
• "inputValidation": "string", A text string. Optional.
• "fontSpecs": "string", Loose description of text attributes, color, font face, and/or size. Optional.
• "choices": "string", A text string. Optional.
• "description": "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": "rtc.insertField",
 "params": 
   {
    "fieldname:": "Body",
    "fieldType:": "Lorem ipsum dolor",
    "editType:": "Duis aute irure",
    "defaultFormula:": "sint occaecat",
    "inputTranslation:": "ullamco laboris"
   }
}

Response:204 No Content

rtc.insertFileAttachment

[Description to be added.]

Parameters

• "pathname": "string", Pathname to the file, resource, or directory.
• "displayFileName": "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": "rtc.insertFileAttachment",
 "params": 
   {
    "pathname:": "Lorem ipsum dolor",
    "displayFileName:": "Duis aute irure",
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rtc.insertFormBody

[Description to be added.]

Parameters

• "name": "string", Name of the design element.

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": "rtc.insertFormBody",
 "params": 
   {
    "name:": "LetterTemplate"
   }
}

Response:204 No Content

rtc.insertHotspot

[Description to be added.]

Parameters

• "hotspotType": "string", A text string.
• "value": "string", A text string.
• "properties": "string", Property pairs such as attr='value' or JSON object representing the same properties. Optional.
• "title": "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": "rtc.insertHotspot",
 "params": 
   {
    "hotspotType:": "Lorem ipsum dolor",
    "value:": "Duis aute irure",
    "properties:": "Spacing='yes' MaxCount=200",
    "title:": "Lorem ipsum dolor"
   }
}

Response:204 No Content

rtc.insertImportFile

[Description to be added.]

Parameters

• "pathname": "string", Pathname to the file, resource, or directory.
• "docTypeOverride": "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": "rtc.insertImportFile",
 "params": 
   {
    "pathname:": "Lorem ipsum dolor",
    "docTypeOverride:": "Duis aute irure"
   }
}

Response:204 No Content

rtc.insertLink

[Description to be added.]

Parameters

• "hyperlinkText": "string", A text string.
• "repIdOrURL": "string", Either a replica id or a URL.
• "viewUNID": "string", Universal ID of a view or folder as a 32-byte hex string. Optional.
• "noteUNID": "string", Universal ID of a note as a 32-byte hex string. Optional.
• "popupText": "string", Popup text to display on mouseover of a link. Optional.
• "serverHint": "string", Domino server to use for resolving doclink if no local replica. "" means there is no server hint. Optional.
• "anchorText": "string", String to use as anchor in either HTML or rich text on a document or form. 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": "rtc.insertLink",
 "params": 
   {
    "hyperlinkText:": "sint occaecat",
    "repIdOrURL:": "F163861C6C08738",
    "viewUNID:": "1F163861C6C938CF2897D2B52087380F",
    "noteUNID:": "938CF2B521F163861C6C087380F897D2",
    "popupText:": "C API Notes/Domino 9.0.1 Reference"
   }
}

Response:204 No Content

rtc.insertMatching

[Description to be added.]

Parameters

• "server": "string", Domino server where a database resides, or "" for a local database. Optional.
• "filePath": "string", File pathname to database, often relative to data directory.
• "viewName": "string", Name of a view or folder. May be main view name or an alias.
• "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": "rtc.insertMatching",
 "params": 
   {
    "server:": "Alibaba/Genii",
    "filePath:": "Orders.nsf",
    "viewName:": "By Date",
    "fieldname:": "Body",
    "fieldname2:": "BriefDesc"
   }
}

Response:204 No Content

rtc.insertNewLines

[Description to be added.]

Parameters

• "count": num, A number for an unsigned short integer.
• "newParagraph": 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": "rtc.insertNewLines",
 "params": 
   {
    "count:": 19,
    "newParagraph:": true
   }
}

Response:204 No Content

rtc.insertPageBody

[Description to be added.]

Parameters

• "name": "string", Name of the design element.

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": "rtc.insertPageBody",
 "params": 
   {
    "name:": "LetterTemplate"
   }
}

Response:204 No Content

rtc.insertPageBreak

[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": "rtc.insertPageBreak"
}

Response:204 No Content

rtc.insertParagraph

Inserts a new paragraph before the current chunk. (Note: If the scope of the chunk is defined as Inside, this usually inserts inside the target)

Parameters

• "paragraphStyle": "string", A text string.
• "fontSpecs": "string", Loose description of text attributes, color, font face, and/or size. Optional.
• "hideFormula": "string", A text string. Optional.

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": "rtc.insertParagraph",
 "params": 
   {
    "paragraphStyle:": "Lorem ipsum dolor",
    "fontSpecs:": "-Bold 10pt",
    "hideFormula:": "sint occaecat"
   },
 "id": 1
}

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

rtc.insertRTChunk

[Description to be added.]

Parameters

• "chunk": ExcitonRTChunk A class instance object.
• "respectParagraphStyles": 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": "rtc.insertRTChunk",
 "params": 
   {
    "chunk:": sampleParam1,
    "respectParagraphStyles:": true
   }
}

Response:204 No Content

rtc.insertRTItem

[Description to be added.]

Parameters

• "serverOrRTItem": ExcitonRTItem A class instance object.
• "filePath": "string", File pathname to database, often relative to data directory. Optional.
• "noteID": "string", A text string. Optional.
• "fieldname": "string", Name of the Notes item (defaults to 'Body' for rich text fields). 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": "rtc.insertRTItem",
 "params": 
   {
    "serverOrRTItem:": sampleParam1,
    "filePath:": "Sample.nsf",
    "noteID:": "Lorem ipsum dolor",
    "fieldname:": "Comments"
   }
}

Response:204 No Content

rtc.insertResource

[Description to be added.]

Parameters

• "resourceType": "string", A text string.
• "resourceName": "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": "rtc.insertResource",
 "params": 
   {
    "resourceType:": "sint occaecat",
    "resourceName:": "ullamco laboris",
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rtc.insertRow

[Description to be added.]

Parameters

• "copyContents": true/false, A boolean value. Optional.
• "rowToCopy": num, A number for an unsigned short integer. Optional.
• "col1": "string", A text string. Optional.
• "col2": "string", A text string. Optional.
• "col3": "string", A text string. Optional.
• "col4": "string", A text string. Optional.
• "col5": "string", A text string. Optional.
• "col6": "string", A text string. Optional.
• "col7": "string", A text string. Optional.
• "col8": "string", A text string. Optional.
• "col9": "string", A text string. Optional.
• "col10": "string", A text string. Optional.
• "col11": "string", A text string. Optional.
• "col12": "string", A text string. Optional.
• "col13": "string", A text string. Optional.
• "col14": "string", A text string. Optional.
• "col15": "string", A text string. Optional.
• "col16": "string", A text string. Optional.
• "col17": "string", A text string. Optional.
• "col18": "string", A text string. Optional.
• "col19": "string", A text string. Optional.
• "col20": "string", A text string. Optional.

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": "rtc.insertRow",
 "params": 
   {
    "copyContents:": true,
    "rowToCopy:": 3,
    "col1:": "Lorem ipsum dolor",
    "col2:": "Duis aute irure",
    "col3:": "sint occaecat"
   },
 "id": 1
}

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

rtc.insertSubformBody

[Description to be added.]

Parameters

• "name": "string", Name of the design element.

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": "rtc.insertSubformBody",
 "params": 
   {
    "name:": "LetterTemplate"
   }
}

Response:204 No Content

rtc.insertTable

[Description to be added.]

Parameters

• "rowCount": num, A number for an unsigned short integer.
• "columnCount": num, A number for an unsigned short integer.
• "tableProperties": "string", A text string. Optional.
• "col1": "string", A text string. Optional.
• "col2": "string", A text string. Optional.
• "col3": "string", A text string. Optional.
• "col4": "string", A text string. Optional.
• "col5": "string", A text string. Optional.
• "col6": "string", A text string. Optional.
• "col7": "string", A text string. Optional.
• "col8": "string", A text string. Optional.
• "col9": "string", A text string. Optional.
• "col10": "string", A text string. Optional.
• "col11": "string", A text string. Optional.
• "col12": "string", A text string. Optional.
• "col13": "string", A text string. Optional.
• "col14": "string", A text string. Optional.
• "col15": "string", A text string. Optional.
• "col16": "string", A text string. Optional.
• "col17": "string", A text string. Optional.
• "col18": "string", A text string. Optional.
• "col19": "string", A text string. Optional.
• "col20": "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": "rtc.insertTable",
 "params": 
   {
    "rowCount:": 8,
    "columnCount:": 13,
    "tableProperties:": sampleParam3,
    "col1:": sampleParam4,
    "col2:": sampleParam5
   }
}

Response:204 No Content

rtc.insertTabs

[Description to be added.]

Parameters

• "count": num, A number for an unsigned short integer.

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": "rtc.insertTabs",
 "params": 
   {
    "count:": 18
   }
}

Response:204 No Content

rtc.insertText

[Description to be added.]

Parameters

• "text": "string", A text string in UTF8 format.
• "fontSpecs": "string", Loose description of text attributes, color, font face, and/or size. 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": "rtc.insertText",
 "params": 
   {
    "text:": "unde omnis",
    "fontSpecs:": "-Bold 10pt"
   }
}

Response:204 No Content

rtc.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": "rtc.jsonscript",
 "params": 
   {
    "script:": "sint occaecat",
    "saveOnFinish:": true,
    "properties:": "Spacing='yes' MaxCount=200"
   },
 "id": 1
}

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

rtc.keywordMatching

[Description to be added.]

Parameters

• "server": "string", Domino server where a database resides, or "" for a local database. Optional.
• "filePath": "string", File pathname to database, often relative to data directory.
• "viewName": "string", Name of a view or folder. May be main view name or an alias.
• "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

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

Request/Response Example

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{
 "jsonrpc": "2.0",
 "method": "rtc.keywordMatching",
 "params": 
   {
    "server:": "Alibaba/Genii",
    "filePath:": "Orders.nsf",
    "viewName:": "By Date",
    "fieldname:": "Body",
    "fieldname2:": "BriefDesc"
   },
 "id": 1
}

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

rtc.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", Name of a view or folder. May be main view name or an alias.
• "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": "rtc.linkMatching",
 "params": 
   {
    "server:": "Alibaba/Genii",
    "filePath:": "Orders.nsf",
    "viewName:": "By Date",
    "fieldname:": "Body",
    "fieldname2:": "BriefDesc"
   }
}

Response:204 No Content

rtc.makeLink

Make the current chunk into a link based on the arguments passed in.

Parameters

• "repIdOrURL": "string", Either a replica id or a URL.
• "viewUNID": "string", Universal ID of a view or folder as a 32-byte hex string. Optional.
• "noteUNID": "string", Universal ID of a note as a 32-byte hex string. Optional.
• "popupText": "string", Popup text to display on mouseover of a link. Optional.
• "serverHint": "string", Domino server to use for resolving doclink if no local replica. "" means there is no server hint. Optional.
• "anchorText": "string", String to use as anchor in either HTML or rich text on a document or form. 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": "rtc.makeLink",
 "params": 
   {
    "repIdOrURL:": "http://geniisoft.com",
    "viewUNID:": "73C0525659500609669E8E5F799D3696",
    "noteUNID:": "9E8E5F799D36973C0525659500609666",
    "popupText:": "C API Notes/Domino 9.0.1 Reference",
    "serverHint:": "Alibaba/Genii"
   }
}

Response:204 No Content

rtc.makeSection

Make the current chunk into a collapsable section based on the arguments passed in. If for some reason the result is not an acceptable construct, such as a collapsable section around a row in a table, this method will fail.

Parameters

• "title": "string", A text string.
• "fontSpecs": "string", Loose description of text attributes, color, font face, and/or size. Optional.
• "fontColor": "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": "rtc.makeSection",
 "params": 
   {
    "title:": "Lorem ipsum dolor",
    "fontSpecs:": "-Bold 10pt",
    "fontColor:": "sint occaecat"
   }
}

Response:204 No Content

rtc.mergeCells

Merges the specified rectangle of cells into a single merged cell, matching the functionality in the Notes user interface when a set of cells is selected and can then be merged.

Parameters

• "top": num, A number for an unsigned short integer.
• "left": num, A number for an unsigned short integer.
• "bottom": num, A number for an unsigned short integer.
• "right": num, A number for an unsigned short integer.

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": "rtc.mergeCells",
 "params": 
   {
    "top:": 23,
    "left:": 7,
    "bottom:": 12,
    "right:": 17
   },
 "id": 1
}

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

rtc.popupMatching

[Description to be added.]

Parameters

• "server": "string", Domino server where a database resides, or "" for a local database. Optional.
• "filePath": "string", File pathname to database, often relative to data directory.
• "viewName": "string", Name of a view or folder. May be main view name or an alias.
• "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": "rtc.popupMatching",
 "params": 
   {
    "server:": "Alibaba/Genii",
    "filePath:": "Orders.nsf",
    "viewName:": "By Date",
    "fieldname:": "Body",
    "fieldname2:": "BriefDesc"
   }
}

Response:204 No Content

rtc.regexHighlight

[Description to be added.]

Parameters

• "regularExpression": "string", A text string.
• "pattern": "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": "rtc.regexHighlight",
 "params": 
   {
    "regularExpression:": "Duis aute irure",
    "pattern:": "sint occaecat",
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rtc.regexKeywords

[Description to be added.]

Parameters

• "regularExpression": "string", A text string.
• "keywordPattern": "string", A text string.
• "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": "rtc.regexKeywords",
 "params": 
   {
    "regularExpression:": "Lorem ipsum dolor",
    "keywordPattern:": "Duis aute irure",
    "properties:": "Spacing='yes' MaxCount=200"
   },
 "id": 1
}

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

rtc.regexLink

[Description to be added.]

Parameters

• "regularExpression": "string", A text string.
• "urlpattern": "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": "rtc.regexLink",
 "params": 
   {
    "regularExpression:": "Lorem ipsum dolor",
    "urlpattern:": "Duis aute irure",
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rtc.regexPopup

[Description to be added.]

Parameters

• "regularExpression": "string", A text string.
• "popupPattern": "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": "rtc.regexPopup",
 "params": 
   {
    "regularExpression:": "Lorem ipsum dolor",
    "popupPattern:": "Duis aute irure",
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rtc.regexReplace

[Description to be added.]

Parameters

• "regularExpression": "string", A text string.
• "replacementPattern": "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": "rtc.regexReplace",
 "params": 
   {
    "regularExpression:": "Lorem ipsum dolor",
    "replacementPattern:": "Duis aute irure",
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rtc.remove

[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": "rtc.remove"
}

Response:204 No Content

rtc.removeFields

[Description to be added.]

Parameters

• "fieldSpec": "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": "rtc.removeFields",
 "params": 
   {
    "fieldSpec:": "Lorem ipsum dolor"
   }
}

Response:204 No Content

rtc.removeHotspots

Removes all hotspots, including sections, link hotspots, and action hotspots.

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": "rtc.removeHotspots"
}

Response:204 No Content

rtc.removeLinks

Removes all link hotspots and doclinks from the chunk, but leaves the text unaltered (including the font used to indicate links).

Parameters

• "excludeURLs": 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": "rtc.removeLinks",
 "params": 
   {
    "excludeURLs:": true
   }
}

Response:204 No Content

rtc.removeSections

[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": "rtc.removeSections"
}

Response:204 No Content

rtc.replaceMatching

[Description to be added.]

Parameters

• "server": "string", Domino server where a database resides, or "" for a local database. Optional.
• "filePath": "string", File pathname to database, often relative to data directory.
• "viewName": "string", Name of a view or folder. May be main view name or an alias.
• "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": "rtc.replaceMatching",
 "params": 
   {
    "server:": "Alibaba/Genii",
    "filePath:": "Orders.nsf",
    "viewName:": "By Date",
    "fieldname:": "Body",
    "fieldname2:": "BriefDesc"
   }
}

Response:204 No Content

rtc.replaceText

Replace each occurrence of the specified text in the selected chunk to that specified. Additionally, may be used to replace occurrences in formulas, links, and text popups using the optional include_filter parameter.

Parameters

• "target": "string", A text string.
• "replaceWith": "string", A text string.
• "include_Filter": "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": "rtc.replaceText",
 "params": 
   {
    "target:": "Duis aute irure",
    "replaceWith:": "sint occaecat",
    "include_Filter:": "ullamco laboris"
   }
}

Response:204 No Content

rtc.replaceTextWithJSON

[Description to be added.]

Parameters

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

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": "rtc.replaceTextWithJSON",
 "params": 
   {
    "jsondef:": "Ac turpis",
    "properties:": "Spacing='yes' MaxCount=200",
    "include_Filter:": "Lorem ipsum dolor"
   },
 "id": 1
}

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

rtc.setCellBorders

Sets the cell borders for the any cells in the specified chunk.

Parameters

• "top": "string", A text string. Optional.
• "bottom": "string", A text string. Optional.
• "left": "string", A text string. Optional.
• "right": "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": "rtc.setCellBorders",
 "params": 
   {
    "top:": "Duis aute irure",
    "bottom:": "sint occaecat",
    "left:": "ullamco laboris",
    "right:": "Ac turpis"
   }
}

Response:204 No Content

rtc.setHTMLValue

[Description to be added.]

Parameters

• "tagname": "string", A text string.
• "value": "string", A text string.
• "targetType": "string", One of the valid types of targets for rich text chunks, such as 'Table', 'Hotspot', 'Field'. 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": "rtc.setHTMLValue",
 "params": 
   {
    "tagname:": "Feugiat",
    "value:": "Lorem ipsum dolor",
    "targetType:": "NonBlankText"
   }
}

Response:204 No Content

rtc.setTextValue

[Description to be added.]

Parameters

• "subDef": "string", Subdefinition of a rich text chunk to narrow the scope, such as 'Row 2; Column 1' narrowing the scope of 'Table 2'.
• "text": "string", A text string in UTF8 format.
• "fontSpecs": "string", Loose description of text attributes, color, font face, and/or size. 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": "rtc.setTextValue",
 "params": 
   {
    "subDef:": "Text 12",
    "text:": "unde omnis",
    "fontSpecs:": "-Bold 10pt"
   }
}

Response:204 No Content

rtc.sort

[Description to be added.]

Parameters

• "sortBy": "string", A text string.
• "numericSort": true/false, A boolean value. Optional.
• "reverseSort": 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": "rtc.sort",
 "params": 
   {
    "sortBy:": "sint occaecat",
    "numericSort:": true,
    "reverseSort:": true
   }
}

Response:204 No Content

rtc.sortByRow

Sorts the rows in the table in a rich text chunk, based on the text value in the columns of the row specified. Entire row sorts along with the specified column text. Title row may be skipped if desired.

Parameters

• "row": num, A number for an unsigned short integer.
• "skipTitle": true/false, A boolean value. Optional.
• "numericSort": true/false, A boolean value. Optional.
• "reverseSort": 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": "rtc.sortByRow",
 "params": 
   {
    "row:": 22,
    "skipTitle:": true,
    "numericSort:": true,
    "reverseSort:": true,
    "properties:": "Spacing='yes' MaxCount=200"
   }
}

Response:204 No Content

rtc.splitCells

Splits all cells in the table that are currently merged.

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": "rtc.splitCells"
}

Response:204 No Content

rtc.verifyGraphics

[Description to be added.]

Parameters

• "mode": num, A number for an unsigned short 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 short integer.

Request/Response Example

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

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

rtc.zoomIn

[Description to be added.]

Parameters

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

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": "rtc.zoomIn",
 "params": 
   {
    "definition:": "After Section 2"
   }
}

Response:204 No Content

rtc.zoomOut

[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": "rtc.zoomOut"
}

Response:204 No Content

rtc.getAccentSensitive / rtc.setAccentSensitive

[Description to be added.]

Parameters (for rtc.setAccentSensitive only)

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

Response (for rtc.getAccentSensitive 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": "rtc.getAccentSensitive","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": "rtc.setAccentSensitive","params": true}

Response:204 No Content

rtc.getActionFormula / rtc.setActionFormula

[Description to be added.]

Parameters (for rtc.setActionFormula only)

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

Response (for rtc.getActionFormula only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getActionFormula","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": "rtc.setActionFormula","params": "a text value"}

Response:204 No Content

rtc.getAnchorText / rtc.setAnchorText

[Description to be added.]

Parameters (for rtc.setAnchorText only)

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

Response (for rtc.getAnchorText only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getAnchorText","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": "rtc.setAnchorText","params": "a text value"}

Response:204 No Content

rtc.getAttachmentMD5

[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": "rtc.getAttachmentMD5","id": 1}

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

Response:204 No Content

rtc.getButtonText / rtc.setButtonText

[Description to be added.]

Parameters (for rtc.setButtonText only)

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

Response (for rtc.getButtonText only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getButtonText","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": "rtc.setButtonText","params": "a text value"}

Response:204 No Content

rtc.getCaseSensitive / rtc.setCaseSensitive

[Description to be added.]

Parameters (for rtc.setCaseSensitive only)

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

Response (for rtc.getCaseSensitive 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": "rtc.getCaseSensitive","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": "rtc.setCaseSensitive","params": true}

Response:204 No Content

rtc.getCellColor / rtc.setCellColor

The cell background color. Will get the first background color, but will set the cell background color for the any cells in the chunk.

Parameters (for rtc.setCellColor only)

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

Response (for rtc.getCellColor only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getCellColor","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": "rtc.setCellColor","params": "a text value"}

Response:204 No Content

rtc.getCellIsMerged

[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": "rtc.getCellIsMerged","id": 1}

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

Response:204 No Content

rtc.getClientJavaScript / rtc.setClientJavaScript

[Description to be added.]

Parameters (for rtc.setClientJavaScript only)

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

Response (for rtc.getClientJavaScript only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getClientJavaScript","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": "rtc.setClientJavaScript","params": "a text value"}

Response:204 No Content

rtc.getComplexText

[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": "rtc.getComplexText","id": 1}

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

Response:204 No Content

rtc.getCompressedFileSize

[Description to be added.]

Parameters

No "params" should be included.

Response

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

Request/Response Example

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

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

Response:204 No Content

rtc.getContainsSomething

[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": "rtc.getContainsSomething","id": 1}

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

Response:204 No Content

rtc.getContainsText

[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": "rtc.getContainsText","id": 1}

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

Response:204 No Content

rtc.getDefinition

[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": "rtc.getDefinition","id": 1}

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

Response:204 No Content

rtc.getEventRetShort2 / rtc.setEventRetShort2

[Description to be added.]

Parameters (for rtc.setEventRetShort2 only)

• "paramS": [number], A number representing an unsigned short integer.

Response (for rtc.getEventRetShort2 only)

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

Request/Response Examples

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

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

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rtc.setEventRetShort2","params": 22}

Response:204 No Content

rtc.getEventRetString3 / rtc.setEventRetString3

[Description to be added.]

Parameters (for rtc.setEventRetString3 only)

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

Response (for rtc.getEventRetString3 only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getEventRetString3","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": "rtc.setEventRetString3","params": "a text value"}

Response:204 No Content

rtc.getEventRetString5 / rtc.setEventRetString5

[Description to be added.]

Parameters (for rtc.setEventRetString5 only)

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

Response (for rtc.getEventRetString5 only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getEventRetString5","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": "rtc.setEventRetString5","params": "a text value"}

Response:204 No Content

rtc.getEventRetshort1 / rtc.setEventRetshort1

[Description to be added.]

Parameters (for rtc.setEventRetshort1 only)

• "paramS": [number], A number representing an unsigned short integer.

Response (for rtc.getEventRetshort1 only)

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

Request/Response Examples

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

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

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rtc.setEventRetshort1","params": 22}

Response:204 No Content

rtc.getEventRetstring4 / rtc.setEventRetstring4

[Description to be added.]

Parameters (for rtc.setEventRetstring4 only)

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

Response (for rtc.getEventRetstring4 only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getEventRetstring4","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": "rtc.setEventRetstring4","params": "a text value"}

Response:204 No Content

rtc.getEventretString1 / rtc.setEventretString1

[Description to be added.]

Parameters (for rtc.setEventretString1 only)

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

Response (for rtc.getEventretString1 only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getEventretString1","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": "rtc.setEventretString1","params": "a text value"}

Response:204 No Content

rtc.getEventretString2 / rtc.setEventretString2

[Description to be added.]

Parameters (for rtc.setEventretString2 only)

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

Response (for rtc.getEventretString2 only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getEventretString2","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": "rtc.setEventretString2","params": "a text value"}

Response:204 No Content

rtc.getEventretString6 / rtc.setEventretString6

[Description to be added.]

Parameters (for rtc.setEventretString6 only)

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

Response (for rtc.getEventretString6 only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getEventretString6","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": "rtc.setEventretString6","params": "a text value"}

Response:204 No Content

rtc.getExists

[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": "rtc.getExists","id": 1}

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

Response:204 No Content

rtc.getFileCompression

[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": "rtc.getFileCompression","id": 1}

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

Response:204 No Content

rtc.getFileCreated

[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": "rtc.getFileCreated","id": 1}

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

Response:204 No Content

rtc.getFileModified

[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": "rtc.getFileModified","id": 1}

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

Response:204 No Content

rtc.getFileName

[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": "rtc.getFileName","id": 1}

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

Response:204 No Content

rtc.getFileSize

[Description to be added.]

Parameters

No "params" should be included.

Response

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

Request/Response Example

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

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

Response:204 No Content

rtc.getFirstRecord

[Description to be added.]

Parameters

No "params" should be included.

Response

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

Request/Response Example

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

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

Response:204 No Content

rtc.getFont / rtc.setFont

[Description to be added.]

Parameters (for rtc.setFont only)

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

Response (for rtc.getFont only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getFont","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": "rtc.setFont","params": "a text value"}

Response:204 No Content

rtc.getFontColor / rtc.setFontColor

[Description to be added.]

Parameters (for rtc.setFontColor only)

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

Response (for rtc.getFontColor only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getFontColor","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": "rtc.setFontColor","params": "a text value"}

Response:204 No Content

rtc.getFontFace / rtc.setFontFace

[Description to be added.]

Parameters (for rtc.setFontFace only)

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

Response (for rtc.getFontFace only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getFontFace","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": "rtc.setFontFace","params": "a text value"}

Response:204 No Content

rtc.getGraphicContentID

[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": "rtc.getGraphicContentID","id": 1}

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

Response:204 No Content

rtc.getGraphicFormat

[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": "rtc.getGraphicFormat","id": 1}

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

Response:204 No Content

rtc.getGraphicHeight / rtc.setGraphicHeight

[Description to be added.]

Parameters (for rtc.setGraphicHeight only)

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

Response (for rtc.getGraphicHeight 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": "rtc.getGraphicHeight","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": "rtc.setGraphicHeight","params": 6.37}

Response:204 No Content

rtc.getGraphicLen

[Description to be added.]

Parameters

No "params" should be included.

Response

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

Request/Response Example

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

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

Response:204 No Content

rtc.getGraphicMD5

[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": "rtc.getGraphicMD5","id": 1}

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

Response:204 No Content

rtc.getGraphicOffset

[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": "rtc.getGraphicOffset","id": 1}

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

Response:204 No Content

rtc.getGraphicStorage / rtc.setGraphicStorage

[Description to be added.]

Parameters (for rtc.setGraphicStorage only)

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

Response (for rtc.getGraphicStorage only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getGraphicStorage","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": "rtc.setGraphicStorage","params": "a text value"}

Response:204 No Content

rtc.getGraphicUnit

[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": "rtc.getGraphicUnit","id": 1}

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

Response:204 No Content

rtc.getGraphicWidth / rtc.setGraphicWidth

[Description to be added.]

Parameters (for rtc.setGraphicWidth only)

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

Response (for rtc.getGraphicWidth 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": "rtc.getGraphicWidth","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": "rtc.setGraphicWidth","params": 6.37}

Response:204 No Content

rtc.getGraphicratio

[Description to be added.]

Parameters

No "params" should be included.

Response

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

Request/Response Example

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

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

Response:204 No Content

rtc.getHideFormula / rtc.setHideFormula

[Description to be added.]

Parameters (for rtc.setHideFormula only)

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

Response (for rtc.getHideFormula only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getHideFormula","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": "rtc.setHideFormula","params": "a text value"}

Response:204 No Content

rtc.getHotSpotBorder / rtc.setHotSpotBorder

[Description to be added.]

Parameters (for rtc.setHotSpotBorder only)

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

Response (for rtc.getHotSpotBorder 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": "rtc.getHotSpotBorder","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": "rtc.setHotSpotBorder","params": true}

Response:204 No Content

rtc.getImageInPixels / rtc.setImageInPixels

[Description to be added.]

Parameters (for rtc.setImageInPixels only)

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

Response (for rtc.getImageInPixels 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": "rtc.getImageInPixels","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": "rtc.setImageInPixels","params": true}

Response:204 No Content

rtc.getInsideHotspot

[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": "rtc.getInsideHotspot","id": 1}

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

Response:204 No Content

rtc.getLanguageStyle / rtc.setLanguageStyle

[Description to be added.]

Parameters (for rtc.setLanguageStyle only)

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

Response (for rtc.getLanguageStyle only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getLanguageStyle","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": "rtc.setLanguageStyle","params": "a text value"}

Response:204 No Content

rtc.getLanguageTag / rtc.setLanguageTag

[Description to be added.]

Parameters (for rtc.setLanguageTag only)

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

Response (for rtc.getLanguageTag only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getLanguageTag","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": "rtc.setLanguageTag","params": "a text value"}

Response:204 No Content

rtc.getLastRecord

[Description to be added.]

Parameters

No "params" should be included.

Response

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

Request/Response Example

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

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

Response:204 No Content

rtc.getLinkAnchorText / rtc.setLinkAnchorText

[Description to be added.]

Parameters (for rtc.setLinkAnchorText only)

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

Response (for rtc.getLinkAnchorText only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getLinkAnchorText","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": "rtc.setLinkAnchorText","params": "a text value"}

Response:204 No Content

rtc.getLinkHintServer / rtc.setLinkHintServer

[Description to be added.]

Parameters (for rtc.setLinkHintServer only)

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

Response (for rtc.getLinkHintServer only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getLinkHintServer","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": "rtc.setLinkHintServer","params": "a text value"}

Response:204 No Content

rtc.getLinkNoteUNID / rtc.setLinkNoteUNID

[Description to be added.]

Parameters (for rtc.setLinkNoteUNID only)

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

Response (for rtc.getLinkNoteUNID only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getLinkNoteUNID","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": "rtc.setLinkNoteUNID","params": "a text value"}

Response:204 No Content

rtc.getLinkPopupText / rtc.setLinkPopupText

[Description to be added.]

Parameters (for rtc.setLinkPopupText only)

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

Response (for rtc.getLinkPopupText only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getLinkPopupText","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": "rtc.setLinkPopupText","params": "a text value"}

Response:204 No Content

rtc.getLinkReplicaID / rtc.setLinkReplicaID

[Description to be added.]

Parameters (for rtc.setLinkReplicaID only)

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

Response (for rtc.getLinkReplicaID only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getLinkReplicaID","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": "rtc.setLinkReplicaID","params": "a text value"}

Response:204 No Content

rtc.getLinkURL / rtc.setLinkURL

[Description to be added.]

Parameters (for rtc.setLinkURL only)

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

Response (for rtc.getLinkURL only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getLinkURL","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": "rtc.setLinkURL","params": "a text value"}

Response:204 No Content

rtc.getLinkViewUNID / rtc.setLinkViewUNID

[Description to be added.]

Parameters (for rtc.setLinkViewUNID only)

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

Response (for rtc.getLinkViewUNID only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getLinkViewUNID","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": "rtc.setLinkViewUNID","params": "a text value"}

Response:204 No Content

rtc.getListType

[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": "rtc.getListType","id": 1}

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

Response:204 No Content

rtc.getMaxRightMargin

[Description to be added.]

Parameters

No "params" should be included.

Response

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

Request/Response Example

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

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

Response:204 No Content

rtc.getMinLeftMargin

[Description to be added.]

Parameters

No "params" should be included.

Response

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

Request/Response Example

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

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

Response:204 No Content

rtc.getOLEFileName

[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": "rtc.getOLEFileName","id": 1}

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

Response:204 No Content

rtc.getOnlyAttachments

[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": "rtc.getOnlyAttachments","id": 1}

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

Response:204 No Content

rtc.getOriginalFileName

[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": "rtc.getOriginalFileName","id": 1}

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

Response:204 No Content

rtc.getPABID

[Description to be added.]

Parameters

No "params" should be included.

Response

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

Request/Response Example

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

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

Response:204 No Content

rtc.getParagraphStyle / rtc.setParagraphStyle

[Description to be added.]

Parameters (for rtc.setParagraphStyle only)

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

Response (for rtc.getParagraphStyle only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getParagraphStyle","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": "rtc.setParagraphStyle","params": "a text value"}

Response:204 No Content

rtc.getParagraphType

[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": "rtc.getParagraphType","id": 1}

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

Response:204 No Content

rtc.getPassthruHTML / rtc.setPassthruHTML

[Description to be added.]

Parameters (for rtc.setPassthruHTML only)

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

Response (for rtc.getPassthruHTML 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": "rtc.getPassthruHTML","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": "rtc.setPassthruHTML","params": true}

Response:204 No Content

rtc.getPointSize / rtc.setPointSize

[Description to be added.]

Parameters (for rtc.setPointSize only)

• "paramS": [number], A number representing an unsigned short integer.

Response (for rtc.getPointSize only)

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

Request/Response Examples

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

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

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0",
 "method": "rtc.setPointSize","params": 22}

Response:204 No Content

rtc.getPopUpText / rtc.setPopUpText

[Description to be added.]

Parameters (for rtc.setPopUpText only)

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

Response (for rtc.getPopUpText only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getPopUpText","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": "rtc.setPopUpText","params": "a text value"}

Response:204 No Content

rtc.getRTItem / rtc.setRTItem

[Description to be added.]

Parameters (for rtc.setRTItem only)

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

Response (for rtc.getRTItem only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getRTItem","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": "rtc.setRTItem","params": 1342}

Response:204 No Content

rtc.getRecordType

[Description to be added.]

Parameters

No "params" should be included.

Response

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

Request/Response Example

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

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

Response:204 No Content

rtc.getRegularExpression / rtc.setRegularExpression

[Description to be added.]

Parameters (for rtc.setRegularExpression only)

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

Response (for rtc.getRegularExpression 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": "rtc.getRegularExpression","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": "rtc.setRegularExpression","params": true}

Response:204 No Content

rtc.getResourcename

[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": "rtc.getResourcename","id": 1}

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

Response:204 No Content

rtc.getRichTextLen

[Description to be added.]

Parameters

No "params" should be included.

Response

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

Request/Response Example

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

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

Response:204 No Content

rtc.getRichTextMD5

[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": "rtc.getRichTextMD5","id": 1}

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

Response:204 No Content

rtc.getRowLabel / rtc.setRowLabel

[Description to be added.]

Parameters (for rtc.setRowLabel only)

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

Response (for rtc.getRowLabel only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getRowLabel","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": "rtc.setRowLabel","params": "a text value"}

Response:204 No Content

rtc.getSearchWordBoundaries / rtc.setSearchWordBoundaries

[Description to be added.]

Parameters (for rtc.setSearchWordBoundaries only)

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

Response (for rtc.getSearchWordBoundaries 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": "rtc.getSearchWordBoundaries","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": "rtc.setSearchWordBoundaries","params": true}

Response:204 No Content

rtc.getSectionTitle / rtc.setSectionTitle

[Description to be added.]

Parameters (for rtc.setSectionTitle only)

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

Response (for rtc.getSectionTitle only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getSectionTitle","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": "rtc.setSectionTitle","params": "a text value"}

Response:204 No Content

rtc.getSetImpliedProperties / rtc.setSetImpliedProperties

[Description to be added.]

Parameters (for rtc.setSetImpliedProperties only)

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

Response (for rtc.getSetImpliedProperties 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": "rtc.getSetImpliedProperties","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": "rtc.setSetImpliedProperties","params": true}

Response:204 No Content

rtc.getSimpleParagraphStyle / rtc.setSimpleParagraphStyle

[Description to be added.]

Parameters (for rtc.setSimpleParagraphStyle only)

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

Response (for rtc.getSimpleParagraphStyle only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getSimpleParagraphStyle","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": "rtc.setSimpleParagraphStyle","params": "a text value"}

Response:204 No Content

rtc.getStyleName

[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": "rtc.getStyleName","id": 1}

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

Response:204 No Content

rtc.getSubformName

[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": "rtc.getSubformName","id": 1}

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

Response:204 No Content

rtc.getTableFitToWindow / rtc.setTableFitToWindow

[Description to be added.]

Parameters (for rtc.setTableFitToWindow only)

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

Response (for rtc.getTableFitToWindow 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": "rtc.getTableFitToWindow","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": "rtc.setTableFitToWindow","params": true}

Response:204 No Content

rtc.getTargetColumn

[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": "rtc.getTargetColumn","id": 1}

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

Response:204 No Content

rtc.getTargetFrame / rtc.setTargetFrame

[Description to be added.]

Parameters (for rtc.setTargetFrame only)

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

Response (for rtc.getTargetFrame only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getTargetFrame","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": "rtc.setTargetFrame","params": "a text value"}

Response:204 No Content

rtc.getTargetNth

[Description to be added.]

Parameters

No "params" should be included.

Response

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

Request/Response Example

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

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

Response:204 No Content

rtc.getTargetRow

[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": "rtc.getTargetRow","id": 1}

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

Response:204 No Content

rtc.getTargetType

[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": "rtc.getTargetType","id": 1}

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

Response:204 No Content

rtc.getText / rtc.setText

[Description to be added.]

Parameters (for rtc.setText only)

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

Response (for rtc.getText only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getText","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": "rtc.setText","params": "a text value"}

Response:204 No Content

rtc.getTextAttributes / rtc.setTextAttributes

[Description to be added.]

Parameters (for rtc.setTextAttributes only)

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

Response (for rtc.getTextAttributes only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getTextAttributes","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": "rtc.setTextAttributes","params": "a text value"}

Response:204 No Content

rtc.getTextLen

[Description to be added.]

Parameters

No "params" should be included.

Response

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

Request/Response Example

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

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

Response:204 No Content

rtc.getTextMD5

[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": "rtc.getTextMD5","id": 1}

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

Response:204 No Content

rtc.getTextWildcards / rtc.setTextWildcards

[Description to be added.]

Parameters (for rtc.setTextWildcards only)

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

Response (for rtc.getTextWildcards 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": "rtc.getTextWildcards","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": "rtc.setTextWildcards","params": true}

Response:204 No Content

rtc.getUnformattedText / rtc.setUnformattedText

[Description to be added.]

Parameters (for rtc.setUnformattedText only)

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

Response (for rtc.getUnformattedText only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getUnformattedText","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": "rtc.setUnformattedText","params": "a text value"}

Response:204 No Content

rtc.getUnzoomedDefinition

[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": "rtc.getUnzoomedDefinition","id": 1}

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

Response:204 No Content

rtc.getWebJavaScript / rtc.setWebJavaScript

[Description to be added.]

Parameters (for rtc.setWebJavaScript only)

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

Response (for rtc.getWebJavaScript only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/{unid}/rtitems/{itemname}/rpc
{"jsonrpc": "2.0", "method": "rtc.getWebJavaScript","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": "rtc.setWebJavaScript","params": "a text value"}

Response:204 No Content