DocAPI.v1.REST

hidden class DocAPI.v1.REST extends %CSP.REST

http://localhost:57772/api/docbook/key/alock

This REST API provides the following calls for obtaining content:

• GET /key/:docbookid - retrieves the content of the given DocBookId. This content is either the full content or the table of contents (down to the <sect2> level). For details, see DocAPI.v1.Content.
• GET /key/:docbookid/:level - retrieves the content of the given DocBookId, down to the given level.
• GET /toc/:docbookid - retrieves the table of contents for the given DocBookId, down to the <sect2> level). For details, see DocAPI.v1.Content.
• GET /toc/:docbookid/:level - retrieves the table of contents for the given DocBookId, down to the given level.

It also provides the following calls for use in searching:

• GET /searchinfo - returns an object that contains information for use in populating the search options. See DocAPI.v1.Search for details.
• GET /search/:phrase - given a phrase, executes a search and returns the first page of results.
• GET /search/:phrase/:pageNumber - given a phrase and a page number, executes a search and returns the given page of results.
• GET /search/:phrase/:pageNumber/:product
• GET /search/:phrase/:pageNumber/:product/:book
• GET /search/:phrase/:pageNumber/:product/:book/:tags
• GET /search/:phrase/:pageNumber/:product/:book/:tags/:searchType
• GET /search/:phrase/:pageNumber/:product/:book/:tags/:searchType/:operator

To use the default value for product, book, tags, searchType, or operator, specify 0 for that parameter. E.g. /search/findthisphrase/1/0/0/SQL finds the first page of results for the phrase findthisphrase, filtered to topics tagged with SQL.

Method Inventory

• %ErrorHandler()
• OnPreDispatch()

Parameters

parameter CHARSET = utf-8;

Specifies the default character set for the page. This can be overriden using the <CSP:CONTENT CHARSET=> tag, or by setting the %response.CharSet property in the OnPreHTTP() method. If this parameter is not specified, then for the default charset is utf-8.

parameter CONTENTTYPE = application/json;

Specifies the default content type for the page. This can be overriden using the <CSP:CONTENT TYPE=> tag, or by setting the %response.ContentType property in the OnPreHTTP() method. The default value if this parameter is not set is text/html.

parameter HandleCorsRequest = 1;

Inherited description: This parameter influences the CORS support. The default is an empty string meaning 'not specified'. If set to true (1) then CORS processing is ON. If set to false (0) then CORS processing is OFF. If left unset "" then the decision to process CORS is delegated to the setting on the URL map route.

Methods

classmethod %ErrorHandler(pSC As %Status, ByRef pContinue As %Boolean) as %Status

classmethod OnPreDispatch(pUrl As %String, pMethod As %String, ByRef pContinue As %Boolean) as %Status

Inherited description: This method Gets called prior to dispatch of the request. Put any common code here that you want to be executed for EVERY request. If pContinue is set to 0, the request will NOT be dispatched according to the UrlMap. If this case it's the responsibility of the user to return a response.