mirror/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2026-02-11 17:49:23 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update website

Browse Source
This commit is contained in:
Laurent Cozic
2020-01-21 09:42:27 +00:00
parent e9366a0d41
commit fcd76dabac
10 changed files with 286 additions and 117 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
docs/api/index.html
View File

@@ -384,6 +384,77 @@ for (let portToTest = 41184; portToTest <= 41194; portToTest++) {
<p>Call <strong>GET /ping</strong> to check if the service is available. It should return &quot;JoplinClipperServer&quot; if it works.</p>
<h1>Searching<a name="searching" href="#searching" class="heading-anchor">🔗</a></h1>
<p>Call <strong>GET /search?query=YOUR_QUERY</strong> to search for notes. This end-point supports the <code>field</code> parameter which is recommended to use so that you only get the data that you need. The query syntax is as described in the main documentation: <a href="https://joplinapp.org/#searching">https://joplinapp.org/#searching</a></p>
<p>To retrieve non-notes items, such as notebooks or tags, add a <code>type</code> parameter and set it to the required <a href="#item-type-id">item type name</a>. In that case, full text search will not be used - instead it will be a simple case-insensitive search. You can also use <code>*</code> as a wildcard. This is convenient for example to retrieve notebooks or tags by title.</p>
<p>For example, to retrieve the notebook named &quot;recipes&quot;: <strong>GET /search?query=recipes&amp;type=folder</strong><br>
To retrieve all the tags that start with &quot;project-&quot;: <strong>GET /search?query=project-*&amp;type=tag</strong></p>
<h1>Item type IDs<a name="item-type-ids" href="#item-type-ids" class="heading-anchor">🔗</a></h1>
<p>Item type IDs might be refered to in certain object you will retrieve from the API. This is the correspondance between name and ID:</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>note</td>
<td>1</td>
</tr>
<tr>
<td>folder</td>
<td>2</td>
</tr>
<tr>
<td>setting</td>
<td>3</td>
</tr>
<tr>
<td>resource</td>
<td>4</td>
</tr>
<tr>
<td>tag</td>
<td>5</td>
</tr>
<tr>
<td>note_tag</td>
<td>6</td>
</tr>
<tr>
<td>search</td>
<td>7</td>
</tr>
<tr>
<td>alarm</td>
<td>8</td>
</tr>
<tr>
<td>master_key</td>
<td>9</td>
</tr>
<tr>
<td>item_change</td>
<td>10</td>
</tr>
<tr>
<td>note_resource</td>
<td>11</td>
</tr>
<tr>
<td>resource_local_state</td>
<td>12</td>
</tr>
<tr>
<td>revision</td>
<td>13</td>
</tr>
<tr>
<td>migration</td>
<td>14</td>
</tr>
</tbody>
</table>
<h1>Notes<a name="notes" href="#notes" class="heading-anchor">🔗</a></h1>
<h2>Properties<a name="properties" href="#properties" class="heading-anchor">🔗</a></h2>
<table>