DocAPI.v1.REST
hidden class DocAPI.v1.REST extends %CSP.REST
To use this REST API, create a web application named /api/docbook, and Copy the definition from /csp/docbook. Edit the Dispatch Class to be DocAPI.v1.REST. Then you can invoke the API via URLs like the following example: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
Parameters
Methods
Inherited Members
Inherited Methods
- %ClassIsLatestVersion()
- %ClassName()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %New()
- %OriginalNamespace()
- %PackageName()
- %SetModified()
- AcceptsContentType()
- AccessCheck()
- ConvertParameter()
- Decrypt()
- DispatchMap()
- DispatchRequest()
- Encrypt()
- Error()
- EscapeHTML()
- EscapeURL()
- Http403()
- Http404()
- Http405()
- Http500()
- HyperEventCall()
- HyperEventHead()
- Include()
- InsertHiddenField()
- InsertHiddenFields()
- IsPrivate()
- Link()
- Login()
- OnHTTPHeader()
- OnHandleCorsRequest()
- OnHandleOptionsRequest()
- OnPage()
- OnPageError()
- OnPostHTTP()
- OnPostHyperEvent()
- OnPreHTTP()
- OnPreHyperEvent()
- Page()
- QuoteJS()
- ReportHttpStatusCode()
- ResolveTarget()
- RewriteURL()
- SetResponseHeaderIfEmpty()
- ShowError()
- StartTimer()
- StatusToJSON()
- StatusToProxyObject()
- StopTimer()
- SupportedVerbs()
- ThrowError()
- UnescapeHTML()
- UnescapeURL()