search-controller

POST /api/notes/{note}/search

Changed on

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/notes/{note}/search
  • Auth
    none declared

Path parameters

noteinteger required

Request body

searchKeystring required
allMyNotebooksAndSubscriptionsboolean
allMyCirclesboolean

Response

OK

hitKind'NOTE' | 'FOLDER' | 'NOTEBOOK' required
folderIdinteger

Present when hitKind is FOLDER

folderNamestring

Present when hitKind is FOLDER

notebookIdinteger

Notebook id for a folder or notebook hit

notebookNamestring

Notebook display name for a folder or notebook hit

distancenumber float

Match score for folder or notebook literal hit (0 exact, 0.9 partial)

Changes

    • info

      added the optional property // to the response with the status