Exciton Boost - REST API

  

4.6.3

Exciton Boost Reference - REST API

This page describes resource collections available for the Exciton Boost REST API, including HTTP methods supported and HTTP headers expected. To navigate between sections, use the table of contents on the right. Replaces AppsFidelity Render offering, while adding significant new features.

Document resources

/api/boost/documents

The Documents resource collection includes all non-design documents in the database. It may be used to create a new document using POST, or as a container for a specified document using the document unique id (unid).

GET {dbpath}/api/boost/documents/{unid}

Retrieve the contents of a Notes document from a database {dbpath} by unique id (unid).

GET {dbpath}/api/boost/documents/batch-{num}

Retrieves all documents created or updated with a specified batch. Mostly used to discover documents after POSTing or PUTing an array of document objects where the URL uses this in the Location header. Documents with a recorded batch will show an item "@batch" which may be used to create the URL.

Request Body

None expected

HTTP headers

Accept Comma-delimited list of response formats accepted. Valid choices:

  • application/json Default. Response will be in JSON.
  • text/xml or application/xml Response will be in XML.
  • text/html Response will the full document rendered in HTML.
  • text/xhtml or application/xhtml+xml Response will the full document rendered in XHTML.

X-JSON-Format Value indicating preferred JSON format. Ignored if JSON is not used. Valid choices:

  • cloudant JSON format used by IBM's Cloudant software.
  • domino Default. JSON format used by native Domino.
  • midas Internal JSON format used by Genii Software's Midas engine.
  • mongodb JSON format used by MongoDB.
  • salesforce JSON format used by Salesforce.
  • watson JSON format used by IBM's Watson software.

Return codes

200 OK Response in request body.
400 Bad Request Error message in request body.
401 Unauthorized User not authorized to view resource.
404 Not Found Resource does not exist, or unavailable based on access level.
500 Server Error Unknown server error or crash.


POST {dbpath}/api/boost/documents

Create new document(s) in a database {dbpath} given a JSON or XML representation. The Location header will contain a link to either the single created document or the batch for the created documents.

Request Body

A JSON object or array of objects. If there is not a Form item, the form is determined by either the X-Domino-Form header or the default form in the database. For example:

{
  "Form": "Profile User",
  "FirstName": "Ben",
  "LastName": "Langhinrichs",
  "Email": "ben@geniisoft.com",
  "Company": "Genii Software",
  "TeamMembers":{"type":"authors",
    "content":["Ben Langhinrichs/Genii"], "Fred Orange/Genii"]
    },
  "Interests": ["Collaboration tools", "JSON", "JavaScript"],
  "Comments": {"type": "html",
    "content":"<div>I own <i>Genii Software</i></div>"
    }
}

HTTP headers

None expected

Return codes

201 Created New document created. URI to access the new document(s) is in the Location header returned. Response body may be ignored.
204 No Content Resource deleted. No response body included.
400 Bad Request Error message in request body.
401 Unauthorized Anonymous user not authorized to delete resource.
403 Forbidden User not authorized to delete resource.
404 Not Found Resource does not exist, or is inaccessible based on access level.
500 Server Error Unknown server error or crash.


DELETE {dbpath}/api/boost/documents/{unid}

Retrieve the contents of a Notes document from a database {dbpath} by unique id (unid).

Request Body

None expected

HTTP headers

None expected

Return codes

200 OK Resource deleted. Response body may be ignored.
204 No Content Resource deleted. No response body included.
400 Bad Request Error message in request body.
401 Unauthorized Anonymous user not authorized to delete resource.
403 Forbidden User not authorized to delete resource.
404 Not Found Resource does not exist, or is inaccessible based on access level.
500 Server Error Unknown server error or crash.


Folder resources

/api/boost/folders

The Folders resource collection includes all public folders in the database. In this version, it is only used to create a list of folders or a list of documents in a folder.

GET {dbpath}/api/boost/folders

Retrieve an array of folder objects listing the title, universal id, private flag, modified date, and data URL used to access it.

GET {dbpath}/api/boost/folders/{unid}

Retrieve an array of document objects including document metadata and the summary columns from the folder.

Request Body

None expected

HTTP headers

Accept Comma-delimited list of response formats accepted. Valid choices:

  • application/json Default. Response will be in JSON.
  • text/xml or application/xml Response will be in XML.

Return codes

200 OK Response in request body.
400 Bad Request Error message in request body.
401 Unauthorized User not authorized to view resource.
404 Not Found Resource does not exist, or unavailable based on access level.
500 Server Error Unknown server error or crash.


View resources

/api/boost/views

The Views resource collection includes all public and private views in the database. In this version, it is only used to create a list of views or a list of documents in a view.

GET {dbpath}/api/boost/views

Retrieve an array of view objects listing the title, universal id, private flag, modified date, and data URL used to access it.

Request Body

None expected

HTTP headers

Accept Comma-delimited list of response formats accepted. Valid choices:

  • application/json Default. Response will be in JSON.
  • text/xml or application/xml Response will be in XML.

Return codes

200 OK Response in request body.
400 Bad Request Error message in request body.
401 Unauthorized User not authorized to view resource.
404 Not Found Resource does not exist, or unavailable based on access level.
500 Server Error Unknown server error or crash.


GET {dbpath}/api/boost/views/{unid}

Retrieve an array of document objects including document metadata and the summary columns from the view.

Request Body

None expected

Optional parameters

count=num Maximum items to return, often used with start=num.

start=num Position of first item in view to return.

HTTP headers

Accept Comma-delimited list of response formats accepted. Valid choices:

  • application/json Default. Response will be in JSON.
  • text/xml or application/xml Response will be in XML.

Return codes

200 OK Response in request body.
400 Bad Request Error message in request body.
401 Unauthorized User not authorized to view resource.
403 Forbidden View is inaccessible. It may not be Boost-enabled.
404 Not Found Resource does not exist, or unavailable based on access level.
500 Server Error Unknown server error or crash.


Form resources

/api/boost/forms

The Forms resource collection includes all forms available in the database. In this version, it is only used to create a list of forms or limited information about a specific form. In an upcoming version, it will also be used to render a form with high fidelity which can then be used and the results posted to Domino.

GET {dbpath}/api/boost/forms

Retrieve an array of form objects listing the title, universal id, private flag, modified date, fields array, and data URL used to access the form.

GET {dbpath}/api/boost/forms/{unid}

Retrieve an array of form objects including metadata and the fields from the form.

Request Body

None expected

HTTP headers

Accept Comma-delimited list of response formats accepted. Valid choices:

  • application/json Default. Response will be in JSON.
  • text/xml or application/xml Response will be in XML.

Return codes

200 OK Response in request body.
400 Bad Request Error message in request body.
401 Unauthorized User not authorized to view resource.
404 Not Found Resource does not exist, or unavailable based on access level.
500 Server Error Unknown server error or crash.


RTItem resources

/api/boost/documents/{unid}/rtitems

The RTItems resource collection includes all the rich text items on the document. It may be used to create, read, update, or delete rich text fields. It does not include MIME fields.

GET {dbpath}/api/boost/documents/{unid}/rtitems

GET {dbpath}/api/boost/documents/{unid}/rtitems/{itemname}

Without the item name specified, retrieves a list of the available rich text items on the document. Does not include MIME items. With an itemname specified, retrieves the rendered version of the rich text item.

Request Body

None expected

HTTP headers

Accept Comma-delimited list of response formats accepted. Valid choices:

  • application/json Default. Response will be in JSON.
  • text/xml or application/xml Response will be in XML.

X-JSON-Format Value indicating preferred JSON format. Ignored if XML is used. Valid choices:

  • cloudant JSON format used by IBM's Cloudant software.
  • domino Default. JSON format used by native Domino.
  • midas Internal JSON format used by Genii Software's Midas engine.
  • mongodb JSON format used by MongoDB.
  • salesforce JSON format used by Salesforce.
  • watson JSON format used by IBM's Watson software.

Return codes

200 OK Response in request body.
400 Bad Request Error message in request body.
401 Unauthorized User not authorized to view resource.
404 Not Found Resource does not exist, or unavailable based on access level.
500 Server Error Unknown server error or crash.


DELETE {dbpath}/api/boost/documents/{unid}

Retrieve the contents of a Notes document from a database {dbpath} by unique id (unid).

Request Body

None expected

HTTP headers

None expected

Return codes

200 OK Resource deleted. Response body may be ignored.
204 No Content Resource deleted. No response body included.
400 Bad Request Error message in request body.
401 Unauthorized Anonymous user not authorized to delete resource.
403 Forbidden User not authorized to delete resource.
404 Not Found Resource does not exist, or is inaccessible based on access level.
500 Server Error Unknown server error or crash.