">

Exciton Boost - RPC API

4.6.3

Remote Procedure Call API Reference - Collection

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

Collection methods


coll.addByFTSearch

Add documents from a database into a collection based on a full text query.

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.
  • "searchString": "string", A text string.
  • "properties": "string", Property pairs such as attr='value' or JSON object representing the same properties. Optional.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/rpc
{
 "jsonrpc": "2.0",
 "method": "coll.addByFTSearch",
 "params": 
   {
    "server:": "Alibaba/Genii",
    "filePath:": "Orders.nsf",
    "searchString:": "Duis aute irure",
    "properties:": "Spacing='yes' MaxCount=200"
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": 2042, "id": 1}

coll.addByFormula

Add documents from a database into a collection based on a Select formula.

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.
  • "formula": "string", Notes formula which will be evaluated against the current Notes context.
  • "properties": "string", Property pairs such as attr='value' or JSON object representing the same properties. Optional.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/rpc
{
 "jsonrpc": "2.0",
 "method": "coll.addByFormula",
 "params": 
   {
    "server:": "Alibaba/Genii",
    "filePath:": "Orders.nsf",
    "formula:": "FirstName+" "+LastName",
    "properties:": "Spacing='yes' MaxCount=200"
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": 2042, "id": 1}

coll.addByView

Add documents from a database into a collection based on a view or folder.

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.
  • "key": "string", A text string. Optional.
  • "properties": "string", Property pairs such as attr='value' or JSON object representing the same properties. Optional.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/rpc
{
 "jsonrpc": "2.0",
 "method": "coll.addByView",
 "params": 
   {
    "server:": "Alibaba/Genii",
    "filePath:": "Orders.nsf",
    "viewName:": "By Date",
    "key:": "sint occaecat",
    "properties:": "Spacing='yes' MaxCount=200"
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": 2042, "id": 1}

coll.addDoc

Add a single document from a database into a collection based on a note id or universal id.

Parameters

  • "server": "string", Domino server where a database resides, or "" for a local database.
  • "filePath": "string", File pathname to database, often relative to data directory.
  • "idStr": "string", Universal ID or Notes ID as a string. Assumed to be UNID if 32-byte hex string.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/rpc
{
 "jsonrpc": "2.0",
 "method": "coll.addDoc",
 "params": 
   {
    "server:": "Alibaba/Genii",
    "filePath:": "Orders.nsf",
    "idStr:": "938CF2B521B116234D6C082410F896D1"
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": true, "id": 1}

coll.addDocBackend

Add a document into a collection by it's note handle.

Parameters

  • "handle": double, A note handle to an open Notes document.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/rpc
{
 "jsonrpc": "2.0",
 "method": "coll.addDocBackend",
 "params": 
   {
    "handle:": 0
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": true, "id": 1}

coll.addLinked

Cycle through documents in the collection, follow doclinks in each rendered document, then add those documents to the collection if they are not in the collection. Linked documents do not need to be in the same database.

Parameters

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

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/rpc
{
 "jsonrpc": "2.0",
 "method": "coll.addLinked",
 "params": 
   {
    "properties:": "Spacing='yes' MaxCount=200"
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": 2042, "id": 1}

coll.exportToCSV

Convert each item in the document (or each specified tem if item_list is given) into a comma separated value, so that each row represents one document. Rich Text fields are rendered to HTML, and both HTML and text fields with commas are escaped appropriately.

Parameters

  • "pathname": "string", Pathname to the file, resource, or directory.
  • "itemList": "string", Comma-separated list of items. Single asterisk includes all Notes items. Optional.
  • "properties": "string", Property pairs such as attr='value' or JSON object representing the same properties. Optional.
  • "linkedItemList": "string", Comma-separated list of items to use with linked documents. Single asterisk includes all Notes items. Optional.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/rpc
{
 "jsonrpc": "2.0",
 "method": "coll.exportToCSV",
 "params": 
   {
    "pathname:": "Lorem ipsum dolor",
    "itemList:": "Subject,Author",
    "properties:": "Spacing='yes' MaxCount=200",
    "linkedItemList:": "Subject,@Now=Time"
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": true, "id": 1}

coll.exportToEPub

[Description to be added.]

Parameters

  • "filename": "string", A text string.
  • "properties": "string", Property pairs such as attr='value' or JSON object representing the same properties. Optional.
  • "frontPages": number, A number for an unsigned long integer. Optional.
  • "endPages": number, A number for an unsigned long integer. Optional.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/rpc
{
 "jsonrpc": "2.0",
 "method": "coll.exportToEPub",
 "params": 
   {
    "filename:": "Duis aute irure",
    "properties:": "Spacing='yes' MaxCount=200",
    "frontPages:": sampleParam3,
    "endPages:": sampleParam4
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": true, "id": 1}

coll.exportToHTML

Convert the rich text in the field to HTML (using logic similar to the GenerateHTML method in the ExcitonRTChunk class) and saves the converted HTML to the filename specified. Images should be saved to disk using the ImageHandling='To Disk' property pair.

Parameters

  • "filename": "string", A text string.
  • "html_Type": "string", A text string.
  • "properties": "string", Property pairs such as attr='value' or JSON object representing the same properties. Optional.
  • "frontPages": number, A number for an unsigned long integer. Optional.
  • "endPages": number, A number for an unsigned long integer. Optional.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/rpc
{
 "jsonrpc": "2.0",
 "method": "coll.exportToHTML",
 "params": 
   {
    "filename:": "Lorem ipsum dolor",
    "html_Type:": "Duis aute irure",
    "properties:": "Spacing='yes' MaxCount=200",
    "frontPages:": sampleParam4,
    "endPages:": sampleParam5
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": true, "id": 1}

coll.exportToJSON

Create a JSON file with the items from the documents in the collection, either all items or specified items. Rich text is converted to HTML according to the properties specified, which includes both HTML generation and JSON specific properties.

Parameters

  • "pathname": "string", Pathname to the file, resource, or directory.
  • "itemList": "string", Comma-separated list of items. Single asterisk includes all Notes items. Optional.
  • "properties": "string", Property pairs such as attr='value' or JSON object representing the same properties. Optional.
  • "linkedItemList": "string", Comma-separated list of items to use with linked documents. Single asterisk includes all Notes items. Optional.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/rpc
{
 "jsonrpc": "2.0",
 "method": "coll.exportToJSON",
 "params": 
   {
    "pathname:": "Lorem ipsum dolor",
    "itemList:": "Subject,Author",
    "properties:": "Spacing='yes' MaxCount=200",
    "linkedItemList:": "Subject,@Now=Time"
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": true, "id": 1}

coll.exportToXML

Create an XML file with the items from the documents in the collection, either all items or specified items. Rich text is converted to HTML according to the properties specified, which includes both HTML generation and XML specific properties.

Parameters

  • "pathname": "string", Pathname to the file, resource, or directory.
  • "itemList": "string", Comma-separated list of items. Single asterisk includes all Notes items. Optional.
  • "properties": "string", Property pairs such as attr='value' or JSON object representing the same properties. Optional.
  • "linkedItemList": "string", Comma-separated list of items to use with linked documents. Single asterisk includes all Notes items. Optional.

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/rpc
{
 "jsonrpc": "2.0",
 "method": "coll.exportToXML",
 "params": 
   {
    "pathname:": "Lorem ipsum dolor",
    "itemList:": "Subject,Author",
    "properties:": "Spacing='yes' MaxCount=200",
    "linkedItemList:": "Subject,@Now=Time"
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": true, "id": 1}

coll.generateCSV

Convert each item in the document (or each specified tem if item_list is given) into a comma separated value, so that each row represents one document. Rich Text fields are rendered to HTML, and both HTML and text fields with commas are escaped appropriately.

Parameters

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

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/rpc
{
 "jsonrpc": "2.0",
 "method": "coll.generateCSV",
 "params": 
   {
    "itemList:": "Subject,Author",
    "properties:": "Spacing='yes' MaxCount=200",
    "linkedItemList:": "Subject,@Now=Time"
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

coll.generateJSON

[Description to be added.]

Parameters

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

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/rpc
{
 "jsonrpc": "2.0",
 "method": "coll.generateJSON",
 "params": 
   {
    "itemList:": "Subject,Author",
    "properties:": "Spacing='yes' MaxCount=200",
    "linkedItemList:": "Subject,@Now=Time"
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

coll.generateXML

Create an XML stream with the items from the documents in the collection, either all items or specified items. Rich text is converted to HTML according to the properties specified, which includes both HTML generation and XML specific properties.

Parameters

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

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/rpc
{
 "jsonrpc": "2.0",
 "method": "coll.generateXML",
 "params": 
   {
    "itemList:": "Subject,Author",
    "properties:": "Spacing='yes' MaxCount=200",
    "linkedItemList:": "Subject,@Now=Time"
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

coll.getDocByUNID

Create a JSON represention of the document identified, including standard metadata as well as specified items.

Parameters

  • "unid": "string", Either JSON doc object including id or universal ID as a 32-byte hex string.
  • "itemList": "string", Comma-separated list of items in addition to standard doc metadata items. Single asterisk includes all Notes items. 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/rpc
{
 "jsonrpc": "2.0",
 "method": "coll.getDocByUNID",
 "params": 
   {
    "unid:": "938CF2B521F163861C6C087380F897D2",
    "itemList:": "Subject,@Now=Time",
    "properties:": "Spacing='yes' MaxCount=200"
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

coll.getFirstDoc

Create a JSON represention of the first document in the collection, including standard metadata as well as specified items.

Parameters

  • "itemList": "string", Comma-separated list of items in addition to standard doc metadata items. Single asterisk includes all Notes items. 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/rpc
{
 "jsonrpc": "2.0",
 "method": "coll.getFirstDoc",
 "params": 
   {
    "itemList:": "Subject,@Now=Time",
    "properties:": "Spacing='yes' MaxCount=200"
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

coll.getNextDoc

Create a JSON represention of the next document in the collection after the one specified, including standard metadata as well as specified items.

Parameters

  • "unid": "string", Either JSON doc object including id or universal ID as a 32-byte hex string.
  • "itemList": "string", Comma-separated list of items in addition to standard doc metadata items. Single asterisk includes all Notes items. 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/rpc
{
 "jsonrpc": "2.0",
 "method": "coll.getNextDoc",
 "params": 
   {
    "unid:": "9E8E5F799D36973C0525659500609666",
    "itemList:": "",
    "properties:": "Spacing='yes' MaxCount=200"
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": "a text value", "id": 1}

coll.sortCollection

Sort the collection based on specified items.

Parameters

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

Response

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

Request/Response Example

Request:POST /{dbpath}/api/boost/rpc
{
 "jsonrpc": "2.0",
 "method": "coll.sortCollection",
 "params": 
   {
    "title:": "Lorem ipsum dolor",
    "category:": "Duis aute irure",
    "category2:": "sint occaecat",
    "properties:": "Spacing='yes' MaxCount=200"
   },
 "id": 1
}
Response:200 OK
{"jsonrpc": "2.0", "result": true, "id": 1}

coll.getCount / coll.setCount

Read-only. The number of documents in the collection.

Parameters (for coll.setCount only)

  • "paramS": [number], A number representing a long integer.

Response (for coll.getCount only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/rpc
{"jsonrpc": "2.0", "method": "coll.getCount","id": 1}
Response:200 OK
{"jsonrpc": "2.0", "result": 1342, "id": 1}
Request:POST /{dbpath}/api/boost/rpc
{"jsonrpc": "2.0",
 "method": "coll.setCount","params": 1342}
Response:204 No Content

coll.getEntriesProcessed / coll.setEntriesProcessed

Read-only. The number of documents processed by an iterative method on the collection.

Parameters (for coll.setEntriesProcessed only)

  • "paramS": [number], A number representing a long integer.

Response (for coll.getEntriesProcessed only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/rpc
{"jsonrpc": "2.0", "method": "coll.getEntriesProcessed","id": 1}
Response:200 OK
{"jsonrpc": "2.0", "result": 1342, "id": 1}
Request:POST /{dbpath}/api/boost/rpc
{"jsonrpc": "2.0",
 "method": "coll.setEntriesProcessed","params": 1342}
Response:204 No Content

coll.getMaxDocs / coll.setMaxDocs

The maximum number of documents in the collection, or if there are more than this number, the number which will be processed by any of the methods.

Parameters (for coll.setMaxDocs only)

  • "paramS": [number], A number representing a long integer.

Response (for coll.getMaxDocs only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/rpc
{"jsonrpc": "2.0", "method": "coll.getMaxDocs","id": 1}
Response:200 OK
{"jsonrpc": "2.0", "result": 1342, "id": 1}
Request:POST /{dbpath}/api/boost/rpc
{"jsonrpc": "2.0",
 "method": "coll.setMaxDocs","params": 1342}
Response:204 No Content

coll.getMaxToAdd / coll.setMaxToAdd

The maximum number of documents to add to the collection with any one of the additive methods.

Parameters (for coll.setMaxToAdd only)

  • "paramS": [number], A number representing a long integer.

Response (for coll.getMaxToAdd only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/rpc
{"jsonrpc": "2.0", "method": "coll.getMaxToAdd","id": 1}
Response:200 OK
{"jsonrpc": "2.0", "result": 1342, "id": 1}
Request:POST /{dbpath}/api/boost/rpc
{"jsonrpc": "2.0",
 "method": "coll.setMaxToAdd","params": 1342}
Response:204 No Content

coll.getSkipInitial / coll.setSkipInitial

Number of documents to skip before processing. May be used in conjunction with MaxDocs property to deal with smaller sets of the collection at a time.

Parameters (for coll.setSkipInitial only)

  • "paramS": [number], A number representing a long integer.

Response (for coll.getSkipInitial only)

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

Request/Response Examples

Request:POST /{dbpath}/api/boost/rpc
{"jsonrpc": "2.0", "method": "coll.getSkipInitial","id": 1}
Response:200 OK
{"jsonrpc": "2.0", "result": 1342, "id": 1}
Request:POST /{dbpath}/api/boost/rpc
{"jsonrpc": "2.0",
 "method": "coll.setSkipInitial","params": 1342}
Response:204 No Content