Skip to content

Build your personal knowledge base with Trilium Notes

feat(docs): name API operations like Redocly

Elian Doranf1fbd01ac5ac
diff --git a/apps/edit-docs/src/openapi_markdown.spec.ts b/apps/edit-docs/src/openapi_markdown.spec.ts
index 5b5bab0d71..a3d2b6ef4f 100644
--- a/apps/edit-docs/src/openapi_markdown.spec.ts
+++ b/apps/edit-docs/src/openapi_markdown.spec.ts
@@ -13,6 +13,7 @@ describe("openApiToMarkdown", () => {
"/notes/{noteId}": {
parameters: [{ name: "noteId", in: "path", required: true, schema: ENTITY_ID }],
patch: {
+ operationId: "patchNote",
description: "Patch a note",
parameters: [{ $ref: "#/components/parameters/Force" }],
requestBody: {
@@ -62,9 +63,12 @@ describe("openApiToMarkdown", () => {
"",
"## Endpoints"
].join("\n"));
- // Operations without a `security` of their own inherit the spec's.
+ // Without a summary, the operation is named by its ID, with the route below. Operations
+ // without a `security` of their own inherit the spec's.
expect(markdown).toContain([
- "### `PATCH /notes/{noteId}`",
+ "### `patchNote`",
+ "",
+ "`PATCH /notes/{noteId}`",
"",
"Patch a note",
"",
@@ -121,7 +125,7 @@ describe("openApiToMarkdown", () => {
const spec: OpenApiSpec = {
info: { title: "Internal" },
paths: {
- "/api/notes": { get: { tags: [ "Notes" ], summary: "List notes", responses: {} } },
+ "/api/notes": { get: { tags: [ "Notes" ], summary: "List notes", operationId: "getNotes", responses: {} } },
"/api/sync": { post: { tags: [ "Sync" ], security: [ { A: [], B: [] }, {} ], responses: {} } },
"/api/login": { post: { tags: [ "Sync" ], security: [], responses: {} } },
"/api/tree": { get: { tags: [ "Notes" ], responses: {} } }
@@ -133,7 +137,8 @@ describe("openApiToMarkdown", () => {
expect(markdown).not.toContain("## Endpoints");
expect(markdown.indexOf("## Notes")).toBeLessThan(markdown.indexOf("### `GET /api/tree`"));
expect(markdown.indexOf("### `GET /api/tree`")).toBeLessThan(markdown.indexOf("## Sync"));
- expect(markdown).toContain("### `GET /api/notes`\n\nList notes\n\n### `GET /api/tree`");
+ // A summary wins over the operation ID; an operation with neither is named by its route.
+ expect(markdown).toContain("### List notes\n\n`GET /api/notes`\n\n### `GET /api/tree`");
// Schemes of one requirement are all needed; an empty requirement makes them optional.
expect(markdown).toContain("**Authorization**: `A` and `B` or none");
diff --git a/apps/edit-docs/src/openapi_markdown.ts b/apps/edit-docs/src/openapi_markdown.ts
index 047d93a19b..666e9429d5 100644
--- a/apps/edit-docs/src/openapi_markdown.ts
+++ b/apps/edit-docs/src/openapi_markdown.ts
@@ -80,6 +80,7 @@ interface Response extends MediaTypes {
}
interface Operation {
+ operationId?: string;
tags?: string[];
summary?: string;
description?: string;
@@ -158,11 +159,12 @@ function groupOperations(spec: OpenApiSpec) {
}
function renderOperation(spec: OpenApiSpec, { method, path, pathItem, operation }: OperationEntry) {
- const blocks = [ `### \`${method.toUpperCase()} ${path}\`` ];
- for (const text of [ operation.summary, operation.description ]) {
- if (text) {
- blocks.push(text.trim());
- }
+ // Named like Redocly does: by summary, else by operation ID, else by the route.
+ const route = code(`${method.toUpperCase()} ${path}`);
+ const title = operation.summary?.trim() || code(operation.operationId ?? "");
+ const blocks = title ? [ `### ${title}`, route ] : [ `### ${route}` ];
+ if (operation.description) {
+ blocks.push(operation.description.trim());
}
const security = operation.security ?? spec.security;
diff --git a/apps/server/src/assets/help/help_content.json b/apps/server/src/assets/help/help_content.json
index 378e3426f9..a2c1879dfb 100644
--- a/apps/server/src/assets/help/help_content.json
+++ b/apps/server/src/assets/help/help_content.json
@@ -220,7 +220,7 @@
"_help_J5Ex1ZrMbyJ6": "<p>Trilium provides a mechanism for <a href=\"#root/_help_CdNpE2pqjmI6\">scripts</a> to open a public REST endpoint. This opens a way for various integrations with other services - a simple example would be creating new note from Slack by issuing a slash command (e.g. <code>/trilium buy milk</code>).</p><h2>Create note from outside Trilium</h2><p>Let's take a look at an example. The goal is to provide a REST endpoint to which we can send title and content and Trilium will create a note.</p><p>We'll start with creating a JavaScript backend <a href=\"#root/_help_6f9hih2hXXZk\">code note</a> containing:</p><pre><code class=\"language-text-x-trilium-auto\">const {req, res} = api;\nconst {secret, title, content} = req.body;\n\nif (req.method == 'POST' &amp;&amp; secret === 'secret-password') {\n // notes must be saved somewhere in the tree hierarchy specified by a parent note. \n // This is defined by a relation from this code note to the \"target\" parent note\n // alternatively you can just use constant noteId for simplicity (get that from \"Note info\" dialog of the desired parent note)\n const targetParentNoteId = api.currentNote.getRelationValue('targetNote');\n \n const {note} = api.createTextNote(targetParentNoteId, title, content);\n const notePojo = note.getPojo();\n\n res.status(201).json(notePojo);\n}\nelse {\n res.send(400);\n}</code></pre><p>This script note has also following two attributes:</p><ul><li>label <code>#customRequestHandler</code> with value <code>create-note</code></li><li>relation <code>~targetNote</code> pointing to a note where new notes should be saved</li></ul><h3>Explanation</h3><p>Let's test this by using an HTTP client to send a request:</p><pre><code class=\"language-text-x-trilium-auto\">POST http://your-trilium-server/custom/create-note\nContent-Type: application/json\n\n{\n \"secret\": \"secret-password\",\n \"title\": \"hello\",\n \"content\": \"world\"\n}+++++++++++++++++++++++++++++++++++++++++++++++</code></pre><p>Notice the <code>/custom</code> part in the request path - Trilium considers any request with this prefix as \"custom\" and tries to find a matching handler by looking at all notes which have <code>customRequestHandler</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a>. Value of this label then contains a regular expression which will match the request path (in our case trivial regex \"create-note\").</p><p>Trilium will then find our code note created above and execute it. <code>api.req</code>, <code>api.res</code> are set to <a href=\"https://expressjs.com/en/api.html#req\">request</a> and <a href=\"https://expressjs.com/en/api.html#res\">response</a>objects from which we can get details of the request and also respond.</p><p>In the code note we check the request method and then use trivial authentication - keep in mind that these endpoints are by default totally unauthenticated, and you need to take care of this yourself.</p><p>Once we pass these checks we will just create the desired note using <a href=\"#root/_help_GLks18SNjxmC\">Script API</a>.</p><h2>Custom resource provider</h2><p>Another common use case is that you want to just expose a file note - in such case you create label <code>customResourceProvider</code> (value is again path regex).</p><p>For more information, see&nbsp;<a href=\"#root/_help_d3fAXQ2diepH\">Custom Resource Providers</a>.</p><h2>Advanced concepts</h2><p><code>api.req</code> and <code>api.res</code> are Express.js objects - you can always look into its <a href=\"https://expressjs.com/en/api.html\">documentation</a> for details.</p><h3>Parameters</h3><p>REST request paths often contain parameters in the URL, e.g.:</p><pre><code class=\"language-text-x-trilium-auto\">http://your-trilium-server/custom/notes/123</code></pre><p>The last part is dynamic so the matching of the URL must also be dynamic - for this reason the matching is done with regular expressions. Following <code>customRequestHandler</code> value would match it:</p><pre><code class=\"language-text-x-trilium-auto\">notes/([0-9]+)</code></pre><p>Additionally, this also defines a matching group with the use of parenthesis which then makes it easier to extract the value. The matched groups are available in <code>api.pathParams</code>:</p><pre><code class=\"language-text-x-trilium-auto\">const noteId = api.pathParams[0];</code></pre><p>Often you also need query params (as in e.g. <code>http://your-trilium-server/custom/notes?noteId=123</code>), you can get those with standard express <code>req.query.noteId</code>.</p>",
"_help_d3fAXQ2diepH": "<p>A custom resource provider allows any file imported into Trilium (images, fonts, stylesheets) to be publicly accessible via a URL.</p><p>A potential use case for this is to add embed a custom font alongside a theme.</p><h2>Steps for creating a custom resource provider</h2><ol><li>Import a file such as an image or a font into Trilium by drag &amp; drop.</li><li>Set the <a href=\"#root/_help_HI6GBBIduIgv\">label</a> <code>#customResourceProvider</code> to <code>hello</code>.</li><li>To test if it is working, use a browser to navigate to <code>&lt;protocol&gt;://&lt;host&gt;/custom/hello</code> (where <code>&lt;protocol&gt;</code> is either <code>http</code> or <code>https</code> based on your setup, and <code>&lt;host&gt;</code> is the host or IP to your Trilium server instance). If you are running the TriliumNext application without a server, use <code>http://localhost:37840</code> as the base URL.</li><li>If everything went well, at the previous step the browser should have downloaded the file uploaded in the first step.</li></ol><p>Instead of <code>hello</code>, the name can be:</p><ul><li>A path, such as <code>fonts/Roboto.ttf</code>, which would be accessible via <code>&lt;host&gt;/custom/fonts/Roboto.ttf</code>.</li><li>As a more advanced use case, a regular expression to match multiple routes, such as <code>hello/.*</code> which will be accessible via <code>/custom/hello/1</code>, <code>/custom/hello/2</code>, <code>/custom/hello/world</code>, etc.</li></ul><h2>Using it in a theme</h2><p>For example, if you have a custom font to be imported by the theme, first upload a font file into Trilium and assign it the <code>#customResourceProvider=fonts/myfont.ttf</code> attribute.</p><p>Then modify the theme CSS to point to:</p><pre><code class=\"language-text-css\">@font-face {\n\tfont-family: customFont;\n\tsrc: url(\"/custom/fonts/myfont.ttf\");\n}\n\ndiv {\n\tfont-family: customFont;\n}</code></pre>",
"_help_pgxEVkzLl1OP": "<aside class=\"admonition tip\"><p>For a quick start, consult the&nbsp;<a class=\"reference-link\" href=\"#root/_help_9qPsTWBorUhQ\">API Reference</a>.</p></aside><p>ETAPI is Trilium's public/external REST API. It is available since Trilium v0.50.</p><h2>API clients</h2><p>As an alternative to calling the API directly, there are client libraries to simplify this</p><ul><li><a href=\"https://github.com/Nriver/trilium-py\">trilium-py</a>, you can use Python to communicate with Trilium.</li></ul><h2>Obtaining a token</h2><p>All operations with the REST API have to be authenticated using a token. You can get this token either from Options -&gt; ETAPI or programmatically using the <code>/auth/login</code> REST call (see the <a href=\"https://github.com/TriliumNext/Trilium/blob/master/src/etapi/etapi.openapi.yaml\">spec</a>).</p><h2>Authentication</h2><h3>Via the <code>Authorization</code> header</h3><pre><code class=\"language-text-x-trilium-auto\">GET https://myserver.com/etapi/app-info\nAuthorization: ETAPITOKEN</code></pre><p>where <code>ETAPITOKEN</code> is the token obtained in the previous step.</p><p>For compatibility with various tools, it's also possible to specify the value of the <code>Authorization</code> header in the format <code>Bearer ETAPITOKEN</code> (since 0.93.0).</p><h3>Basic authentication</h3><p>Since v0.56 you can also use basic auth format:</p><pre><code class=\"language-text-x-trilium-auto\">GET https://myserver.com/etapi/app-info\nAuthorization: Basic BATOKEN</code></pre><ul><li>Where <code>BATOKEN = BASE64(username + ':' + password)</code> - this is a standard Basic Auth serialization</li><li>Where <code>username</code> is \"etapi\"</li><li>And <code>password</code> is the generated ETAPI token described above.</li></ul><p>Basic Auth is meant to be used with tools which support only basic auth.</p><h2>Interaction using Bash scripts</h2><p>It is possible to write simple Bash scripts to interact with Trilium. As an example, here's how to obtain the HTML content of a note:</p><pre><code class=\"language-text-x-trilium-auto\">#!/usr/bin/env bash\n\n# Configuration\nTOKEN=z1vA4fkGxjOR_ZXLrZeqHEFOv65yV3882iFCRtNIK9k9iWrHliITNSLQ=\nSERVER=http://localhost:8080\n\n# Download a note by ID\nNOTE_ID=\"i6ra4ZshJhgN\"\ncurl \"$SERVER/etapi/notes/$NOTE_ID/content\" -H \"Authorization: $TOKEN\" </code></pre><p>Make sure to replace the values of:</p><ul><li><code>TOKEN</code> with your ETAPI token.</li><li><code>SERVER</code> with the correct protocol, host name and port to your Trilium instance.</li><li><code>NOTE_ID</code> with an existing note ID to download.</li></ul><p>As another example, to obtain a .zip export of a note and place it in a directory called <code>out</code>, simply replace the last statement in the script with:</p><pre><code class=\"language-text-x-trilium-auto\">curl -H \"Authorization: $TOKEN\" \\\n\t-X GET \"$SERVER/etapi/notes/$NOTE_ID/export\" \\\n --output \"out/$NOTE_ID.zip\"</code></pre><h2>Uploading binary content</h2><p>A JSON request body can only carry text, so the <code>content</code> field of <code>POST /etapi/attachments</code> stores exactly the string it receives. To upload an image, a PDF or any other binary file, send the raw bytes to the content endpoint with the <code>application/octet-stream</code> content type. The same applies to the content of a note (<code>PUT /etapi/notes/{noteId}/content</code>).</p><p>To attach a file to a note, create the attachment without content, then upload the file to it:</p><pre><code class=\"language-text-x-trilium-auto\">ATTACHMENT_ID=$(curl -s -X POST \"$SERVER/etapi/attachments\" \\\n -H \"Authorization: $TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -d \"{\\\"ownerId\\\": \\\"$NOTE_ID\\\", \\\"role\\\": \\\"file\\\", \\\"mime\\\": \\\"application/pdf\\\", \\\"title\\\": \\\"report.pdf\\\", \\\"position\\\": 10}\" \\\n | jq -r .attachmentId)\n\ncurl -X PUT \"$SERVER/etapi/attachments/$ATTACHMENT_ID/content\" \\\n -H \"Authorization: $TOKEN\" \\\n -H \"Content-Type: application/octet-stream\" \\\n --data-binary @report.pdf</code></pre><p>Use <code>--data-binary</code> rather than <code>-d</code>, which strips line breaks from the file. For an image, set <code>role</code> to <code>image</code> and <code>mime</code> to the image's type, such as <code>image/png</code>.</p>",
- "_help_9qPsTWBorUhQ": "<p>External Trilium API</p><h2>Authentication</h2><h3><code>EtapiTokenAuth</code></h3><p>API key in the <code>Authorization</code> header.</p><h3><code>EtapiBasicAuth</code></h3><p>HTTP <code>basic</code> authentication.</p><p>Basic Auth where username is arbitrary string (e.g. \"trilium\", not checked), username is the ETAPI token. To emphasize, do not use Trilium password here (won't work), only the generated ETAPI token (from Options -&gt; ETAPI)</p><h2>Endpoints</h2><h3><code>POST /create-note</code></h3><p>Create a note and place it into the note tree</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Request body</strong> (required)</p><ul><li><code>application/json</code>: <code>CreateNoteDef</code></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>parentNoteId</code> <br><em>required</em></td><td><code>EntityId</code></td><td>Note ID of the parent note in the tree</td></tr><tr><td><code>title</code> <br><em>required</em></td><td><code>string</code></td><td></td></tr><tr><td><code>type</code> <br><em>required</em></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>book</code>, <code>relationMap</code>, <code>render</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td>this needs to be specified only for note types 'code', 'file', 'image'.</td></tr><tr><td><code>content</code> <br><em>required</em></td><td><code>string</code></td><td></td></tr><tr><td><code>notePosition</code></td><td><code>integer</code></td><td>Position of the note in the parent. Normal ordering is 10, 20, 30 ... So if you want to create a note on the first position, use e.g. 5, for second position 15, for last e.g. 1000000</td></tr><tr><td><code>prefix</code></td><td><code>string</code></td><td>Prefix is branch (placement) specific title prefix for the note. Let's say you have your note placed into two different places in the tree, but you want to change the title a bit in one of the placements. For this you can use prefix.</td></tr><tr><td><code>isExpanded</code></td><td><code>boolean</code></td><td>true if this note (as a folder) should appear expanded</td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>DON'T specify unless you want to force a specific noteId</td></tr><tr><td><code>branchId</code></td><td><code>EntityId</code></td><td>DON'T specify unless you want to force a specific branchId</td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td>Local timestap of the note creation. Specify only if you want to override the default (current datetime in the current timezone/offset).</td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td>UTC timestap of the note creation. Specify only if you want to override the default (current datetime).</td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>UTC timestamp of the note's last modification, e.g. to keep the date of a note being migrated from another application. The local dateModified is derived from it. Specify only if you want to override the default (current datetime).</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"parentNoteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"application/json\",\n \"content\": \"string\",\n \"notePosition\": 0,\n \"prefix\": \"string\",\n \"isExpanded\": true,\n \"noteId\": \"evnnmvHTCgIn\",\n \"branchId\": \"evnnmvHTCgIn\",\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><p><strong>Responses</strong></p><ul><li><p><code>201</code>: note created</p><ul><li><code>application/json; charset=utf-8</code>: <code>NoteWithBranch</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>note</code></td><td><code>Note</code></td><td></td></tr><tr><td><code>branch</code></td><td><code>Branch</code></td><td>Branch places the note into the tree, it represents the relationship between a parent note and child note</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"note\": {\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n },\n \"branch\": {\n \"branchId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"parentNoteId\": \"evnnmvHTCgIn\",\n \"prefix\": \"string\",\n \"notePosition\": 0,\n \"isExpanded\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>GET /notes</code></h3><p>Search notes</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>search</code> <br><em>required</em></td><td>query</td><td><code>string</code></td><td>search query string as described in <a href=\"https://triliumnext.github.io/Docs/Wiki/search.html\">https://triliumnext.github.io/Docs/Wiki/search.html</a></td></tr><tr><td><code>fastSearch</code></td><td>query</td><td><code>boolean</code></td><td>enable fast search (fulltext doesn't look into content)</td></tr><tr><td><code>includeArchivedNotes</code></td><td>query</td><td><code>boolean</code></td><td>search by default ignores archived notes. Set to 'true' to includes archived notes into search results.</td></tr><tr><td><code>ancestorNoteId</code></td><td>query</td><td><code>EntityId</code></td><td>search only in a subtree identified by the subtree noteId. By default whole tree is searched.</td></tr><tr><td><code>ancestorDepth</code></td><td>query</td><td><code>string</code></td><td>define how deep in the tree should the notes be searched</td></tr><tr><td><code>orderBy</code></td><td>query</td><td><code>string</code></td><td>name of the property/label to order search results by</td></tr><tr><td><code>orderDirection</code></td><td>query</td><td><code>string</code></td><td>order direction, ascending or descending. One of <code>asc</code>, <code>desc</code>.</td></tr><tr><td><code>limit</code></td><td>query</td><td><code>integer</code></td><td>limit the number of results you want to receive</td></tr><tr><td><code>debug</code></td><td>query</td><td><code>boolean</code></td><td>set to true to get debug information in the response (search query parsing)</td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: search response</p><ul><li><code>application/json; charset=utf-8</code>: <code>SearchResponse</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>results</code> <br><em>required</em></td><td><code>array of Note</code></td><td></td></tr><tr><td><code>debugInfo</code></td><td><code>object</code></td><td>debugging info on parsing the search query enabled with &amp;debug=true parameter</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"results\": [\n {\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"debugInfo\": {}\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>GET /notes/{noteId}</code></h3><p>Returns a note identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: note response</p><ul><li><code>application/json; charset=utf-8</code>: <code>Note</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the note. Returned as \"[protected]\" for protected notes, since ETAPI cannot open a protected session.</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>attributes</code></td><td><code>AttributeList</code></td><td></td></tr><tr><td><code>parentNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>parentBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>Writable through PATCH, e.g. to restore a migrated note's date after its content was rewritten. The local dateModified is derived from it.</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>DELETE /notes/{noteId}</code></h3><p>deletes a single note based on the noteId supplied</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>204</code>: note deleted</p></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>PATCH /notes/{noteId}</code></h3><p>patch a note identified by the noteId with changes in the body</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Request body</strong> (required)</p><ul><li><code>application/json</code>: <code>Note</code></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the note. Returned as \"[protected]\" for protected notes, since ETAPI cannot open a protected session.</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>attributes</code></td><td><code>AttributeList</code></td><td></td></tr><tr><td><code>parentNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>parentBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>Writable through PATCH, e.g. to restore a migrated note's date after its content was rewritten. The local dateModified is derived from it.</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"blobId\": \"string\",\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><p><strong>Responses</strong></p><ul><li><p><code>200</code>: note updated</p><ul><li><code>application/json; charset=utf-8</code>: <code>Note</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the note. Returned as \"[protected]\" for protected notes, since ETAPI cannot open a protected session.</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>attributes</code></td><td><code>AttributeList</code></td><td></td></tr><tr><td><code>parentNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>parentBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>Writable through PATCH, e.g. to restore a migrated note's date after its content was rewritten. The local dateModified is derived from it.</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>GET /notes/{noteId}/content</code></h3><p>Returns note content identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: note content, served with the note's MIME type as <code>Content-Type</code></p><ul><li><code>*/*</code>: <code>string (binary)</code></li></ul></li></ul><h3><code>PUT /notes/{noteId}/content</code></h3><p>Updates note content identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Request body</strong> (required)</p><p>New content of the note. Send text (such as the HTML of a text note) as <code>text/plain</code> and binary data (such as the file of an image or file note) as <code>application/octet-stream</code>; other content types are not accepted.</p><ul><li><code>text/plain</code>: <code>string</code></li><li><code>application/octet-stream</code>: <code>string (binary)</code></li></ul><p><strong>Responses</strong></p><ul><li><code>204</code>: note content updated</li></ul><h3><code>GET /notes/{noteId}/export</code></h3><p>Exports ZIP file export of a given note subtree. To export whole document, use \"root\" for noteId</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr><tr><td><code>format</code></td><td>query</td><td><code>any</code></td><td>One of <code>html</code>, <code>markdown</code>, <code>share</code>.</td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: export ZIP file</p><ul><li><code>application/zip</code>: <code>string (binary)</code></li></ul></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>POST /notes/{noteId}/import</code></h3><p>Imports ZIP file into a given note.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>201</code>: note created</p><ul><li><code>application/json; charset=utf-8</code>: <code>NoteWithBranch</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>note</code></td><td><code>Note</code></td><td></td></tr><tr><td><code>branch</code></td><td><code>Branch</code></td><td>Branch places the note into the tree, it represents the relationship between a parent note and child note</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"note\": {\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n },\n \"branch\": {\n \"branchId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"parentNoteId\": \"evnnmvHTCgIn\",\n \"prefix\": \"string\",\n \"notePosition\": 0,\n \"isExpanded\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>POST /notes/{noteId}/revision</code></h3><p>Create a note revision for the given note</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr><tr><td><code>format</code></td><td>query</td><td><code>any</code></td><td>One of <code>html</code>, <code>markdown</code>.</td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>204</code>: revision has been created</p></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>GET /notes/{noteId}/revisions</code></h3><p>Returns the revisions of a note identified by its ID. Protected revisions are omitted, since they cannot be read through ETAPI individually either.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: list of revisions</p><ul><li><code>application/json; charset=utf-8</code>: <code>array of Revision</code></li></ul></li></ul><pre><code class=\"language-application-json\">[\n {\n \"revisionId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"title\": \"string\",\n \"blobId\": \"string\",\n \"dateLastEdited\": \"2021-12-31 20:18:11.930+0100\",\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateLastEdited\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\",\n \"contentLength\": 0\n }\n]</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>GET /notes/{noteId}/attachments</code></h3><p>Returns all attachments for a note identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: list of attachments</p><ul><li><code>application/json; charset=utf-8</code>: <code>array of Attachment</code></li></ul></li></ul><pre><code class=\"language-application-json\">[\n {\n \"attachmentId\": \"evnnmvHTCgIn\",\n \"ownerId\": \"evnnmvHTCgIn\",\n \"role\": \"string\",\n \"mime\": \"string\",\n \"title\": \"string\",\n \"position\": 0,\n \"blobId\": \"string\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateScheduledForErasureSince\": \"2021-12-31 19:18:11.930Z\",\n \"contentLength\": 0\n }\n]</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>POST /notes/{noteId}/undelete</code></h3><p>Restore a deleted note. The note must be deleted and must have at least one undeleted parent.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: note restored successfully</p><ul><li><code>application/json; charset=utf-8</code>: <code>object</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>success</code></td><td><code>boolean</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"success\": true\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>GET /notes/history</code></h3><p>Returns recent changes including note creations, modifications, and deletions</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>ancestorNoteId</code></td><td>query</td><td><code>EntityId</code></td><td>Limit changes to a subtree identified by this note ID. Defaults to \"root\" (all notes).</td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: list of recent changes</p><ul><li><code>application/json; charset=utf-8</code>: <code>array of RecentChange</code></li></ul></li></ul><pre><code class=\"language-application-json\">[\n {\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"current_title\": \"string\",\n \"current_isDeleted\": true,\n \"current_deleteId\": \"string\",\n \"current_isProtected\": true,\n \"utcDate\": \"2021-12-31 19:18:11.930Z\",\n \"date\": \"2021-12-31 20:18:11.930+0100\",\n \"canBeUndeleted\": true\n }\n]</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>GET /revisions/{revisionId}</code></h3><p>Returns a revision identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>revisionId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: revision response</p><ul><li><code>application/json; charset=utf-8</code>: <code>Revision</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>revisionId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>dateLastEdited</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateLastEdited</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>contentLength</code></td><td><code>integer (int32)</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"revisionId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"title\": \"string\",\n \"blobId\": \"string\",\n \"dateLastEdited\": \"2021-12-31 20:18:11.930+0100\",\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateLastEdited\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\",\n \"contentLength\": 0\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>GET /revisions/{revisionId}/content</code></h3><p>Returns revision content identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>revisionId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: revision content response</p><ul><li><code>text/html</code>: <code>string</code></li></ul></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>POST /branches</code></h3><p>Create a branch (clone a note to a different location in the tree). In case there is a branch between parent note and child note already, then this will update the existing branch with prefix, notePosition and isExpanded.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Request body</strong> (required)</p><ul><li><code>application/json</code>: <code>Branch</code></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>branchId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>parentNoteId</code></td><td><code>EntityId</code></td><td>identifies the parent note</td></tr><tr><td><code>prefix</code></td><td><code>string</code></td><td></td></tr><tr><td><code>notePosition</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isExpanded</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"branchId\": \"evnnmvHTCgIn\",\n \"prefix\": \"string\",\n \"notePosition\": 0,\n \"isExpanded\": true\n}</code></pre><p><strong>Responses</strong></p><ul><li><p><code>200</code>: branch updated (branch between parent note and child note already existed)</p><ul><li><code>application/json; charset=utf-8</code>: <code>Branch</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>branchId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>parentNoteId</code></td><td><code>EntityId</code></td><td>identifies the parent note</td></tr><tr><td><code>prefix</code></td><td><code>string</code></td><td></td></tr><tr><td><code>notePosition</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isExpanded</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"branchId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"parentNoteId\": \"evnnmvHTCgIn\",\n \"prefix\": \"string\",\n \"notePosition\": 0,\n \"isExpanded\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>201</code>: branch created</p><ul><li><code>application/json; charset=utf-8</code>: <code>Branch</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>branchId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>parentNoteId</code></td><td><code>EntityId</code></td><td>identifies the parent note</td></tr><tr><td><code>prefix</code></td><td><code>string</code></td><td></td></tr><tr><td><code>notePosition</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isExpanded</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"branchId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"parentNoteId\": \"evnnmvHTCgIn\",\n \"prefix\": \"string\",\n \"notePosition\": 0,\n \"isExpanded\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>GET /branches/{branchId}</code></h3><p>Returns a branch identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>branchId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: branch response</p><ul><li><code>application/json; charset=utf-8</code>: <code>Branch</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>branchId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>parentNoteId</code></td><td><code>EntityId</code></td><td>identifies the parent note</td></tr><tr><td><code>prefix</code></td><td><code>string</code></td><td></td></tr><tr><td><code>notePosition</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isExpanded</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"branchId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"parentNoteId\": \"evnnmvHTCgIn\",\n \"prefix\": \"string\",\n \"notePosition\": 0,\n \"isExpanded\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>DELETE /branches/{branchId}</code></h3><p>deletes a branch based on the branchId supplied. If this is the last branch of the (child) note, then the note is deleted as well.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>branchId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>204</code>: branch deleted</p></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>PATCH /branches/{branchId}</code></h3><p>patch a branch identified by the branchId with changes in the body. Only prefix and notePosition can be updated. If you want to update other properties, you need to delete the old branch and create a new one.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>branchId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Request body</strong> (required)</p><ul><li><code>application/json</code>: <code>Branch</code></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>branchId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>parentNoteId</code></td><td><code>EntityId</code></td><td>identifies the parent note</td></tr><tr><td><code>prefix</code></td><td><code>string</code></td><td></td></tr><tr><td><code>notePosition</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isExpanded</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"branchId\": \"evnnmvHTCgIn\",\n \"prefix\": \"string\",\n \"notePosition\": 0,\n \"isExpanded\": true\n}</code></pre><p><strong>Responses</strong></p><ul><li><p><code>200</code>: branch updated</p><ul><li><code>application/json; charset=utf-8</code>: <code>Branch</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>branchId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>parentNoteId</code></td><td><code>EntityId</code></td><td>identifies the parent note</td></tr><tr><td><code>prefix</code></td><td><code>string</code></td><td></td></tr><tr><td><code>notePosition</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isExpanded</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"branchId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"parentNoteId\": \"evnnmvHTCgIn\",\n \"prefix\": \"string\",\n \"notePosition\": 0,\n \"isExpanded\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>POST /attachments</code></h3><p>create an attachment</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Request body</strong> (required)</p><ul><li><code>application/json</code>: <code>CreateAttachment</code></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>ownerId</code></td><td><code>EntityId</code></td><td>identifies the owner of the attachment, is either noteId or revisionId</td></tr><tr><td><code>role</code></td><td><code>string</code></td><td></td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td></td></tr><tr><td><code>content</code></td><td><code>string</code></td><td>Text content of the attachment, stored as-is. To store binary content, create the attachment without it, then upload the data with <code>PUT /attachments/{attachmentId}/content</code>.</td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"ownerId\": \"evnnmvHTCgIn\",\n \"role\": \"string\",\n \"mime\": \"string\",\n \"title\": \"string\",\n \"content\": \"string\",\n \"position\": 0\n}</code></pre><p><strong>Responses</strong></p><ul><li><p><code>201</code>: attachment created</p><ul><li><code>application/json; charset=utf-8</code>: <code>Attachment</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attachmentId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>ownerId</code></td><td><code>EntityId</code></td><td>identifies the owner of the attachment, is either noteId or revisionId</td></tr><tr><td><code>role</code></td><td><code>string</code></td><td></td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the attachment. Returned as \"[protected]\" for protected attachments, since ETAPI cannot open a protected session.</td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateScheduledForErasureSince</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>contentLength</code></td><td><code>integer (int32)</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"attachmentId\": \"evnnmvHTCgIn\",\n \"ownerId\": \"evnnmvHTCgIn\",\n \"role\": \"string\",\n \"mime\": \"string\",\n \"title\": \"string\",\n \"position\": 0,\n \"blobId\": \"string\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateScheduledForErasureSince\": \"2021-12-31 19:18:11.930Z\",\n \"contentLength\": 0\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>GET /attachments/{attachmentId}</code></h3><p>Returns an attachment identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attachmentId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: attachment response</p><ul><li><code>application/json; charset=utf-8</code>: <code>Attachment</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attachmentId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>ownerId</code></td><td><code>EntityId</code></td><td>identifies the owner of the attachment, is either noteId or revisionId</td></tr><tr><td><code>role</code></td><td><code>string</code></td><td></td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the attachment. Returned as \"[protected]\" for protected attachments, since ETAPI cannot open a protected session.</td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateScheduledForErasureSince</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>contentLength</code></td><td><code>integer (int32)</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"attachmentId\": \"evnnmvHTCgIn\",\n \"ownerId\": \"evnnmvHTCgIn\",\n \"role\": \"string\",\n \"mime\": \"string\",\n \"title\": \"string\",\n \"position\": 0,\n \"blobId\": \"string\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateScheduledForErasureSince\": \"2021-12-31 19:18:11.930Z\",\n \"contentLength\": 0\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>DELETE /attachments/{attachmentId}</code></h3><p>deletes an attachment based on the attachmentId supplied.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attachmentId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>204</code>: attachment deleted</p></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>PATCH /attachments/{attachmentId}</code></h3><p>patch an attachment identified by the attachmentId with changes in the body. Only role, mime, title, and position are patchable.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attachmentId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Request body</strong> (required)</p><ul><li><code>application/json</code>: <code>Attachment</code></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attachmentId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>ownerId</code></td><td><code>EntityId</code></td><td>identifies the owner of the attachment, is either noteId or revisionId</td></tr><tr><td><code>role</code></td><td><code>string</code></td><td></td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the attachment. Returned as \"[protected]\" for protected attachments, since ETAPI cannot open a protected session.</td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateScheduledForErasureSince</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>contentLength</code></td><td><code>integer (int32)</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"ownerId\": \"evnnmvHTCgIn\",\n \"role\": \"string\",\n \"mime\": \"string\",\n \"title\": \"string\",\n \"position\": 0,\n \"blobId\": \"string\",\n \"contentLength\": 0\n}</code></pre><p><strong>Responses</strong></p><ul><li><p><code>200</code>: attribute updated</p><ul><li><code>application/json; charset=utf-8</code>: <code>Attachment</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attachmentId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>ownerId</code></td><td><code>EntityId</code></td><td>identifies the owner of the attachment, is either noteId or revisionId</td></tr><tr><td><code>role</code></td><td><code>string</code></td><td></td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the attachment. Returned as \"[protected]\" for protected attachments, since ETAPI cannot open a protected session.</td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateScheduledForErasureSince</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>contentLength</code></td><td><code>integer (int32)</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"attachmentId\": \"evnnmvHTCgIn\",\n \"ownerId\": \"evnnmvHTCgIn\",\n \"role\": \"string\",\n \"mime\": \"string\",\n \"title\": \"string\",\n \"position\": 0,\n \"blobId\": \"string\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateScheduledForErasureSince\": \"2021-12-31 19:18:11.930Z\",\n \"contentLength\": 0\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>GET /attachments/{attachmentId}/content</code></h3><p>Returns attachment content identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attachmentId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: attachment content, served with the attachment's MIME type as <code>Content-Type</code></p><ul><li><code>*/*</code>: <code>string (binary)</code></li></ul></li></ul><h3><code>PUT /attachments/{attachmentId}/content</code></h3><p>Updates attachment content identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attachmentId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Request body</strong> (required)</p><p>New content of the attachment. Send text as <code>text/plain</code> and binary data (such as an image or a PDF) as <code>application/octet-stream</code>; other content types are not accepted.</p><ul><li><code>text/plain</code>: <code>string</code></li><li><code>application/octet-stream</code>: <code>string (binary)</code></li></ul><p><strong>Responses</strong></p><ul><li><code>204</code>: attachment content updated</li></ul><h3><code>POST /attributes</code></h3><p>create an attribute for a given note</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Request body</strong> (required)</p><ul><li><code>application/json</code>: <code>Attribute</code></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attributeId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>label</code>, <code>relation</code>.</td></tr><tr><td><code>name</code></td><td><code>string</code></td><td></td></tr><tr><td><code>value</code></td><td><code>string</code></td><td></td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isInheritable</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"attributeId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true\n}</code></pre><p><strong>Responses</strong></p><ul><li><p><code>201</code>: attribute created</p><ul><li><code>application/json; charset=utf-8</code>: <code>Attribute</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attributeId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>label</code>, <code>relation</code>.</td></tr><tr><td><code>name</code></td><td><code>string</code></td><td></td></tr><tr><td><code>value</code></td><td><code>string</code></td><td></td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isInheritable</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>GET /attributes/{attributeId}</code></h3><p>Returns an attribute identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attributeId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: attribute response</p><ul><li><code>application/json; charset=utf-8</code>: <code>Attribute</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attributeId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>label</code>, <code>relation</code>.</td></tr><tr><td><code>name</code></td><td><code>string</code></td><td></td></tr><tr><td><code>value</code></td><td><code>string</code></td><td></td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isInheritable</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>DELETE /attributes/{attributeId}</code></h3><p>deletes an attribute based on the attributeId supplied.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attributeId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>204</code>: attribute deleted</p></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>PATCH /attributes/{attributeId}</code></h3><p>patch an attribute identified by the attributeId with changes in the body. For labels, only value and position can be updated. For relations, only position can be updated. If you want to modify other properties, you need to delete the old attribute and create a new one.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attributeId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Request body</strong> (required)</p><ul><li><code>application/json</code>: <code>Attribute</code></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attributeId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>label</code>, <code>relation</code>.</td></tr><tr><td><code>name</code></td><td><code>string</code></td><td></td></tr><tr><td><code>value</code></td><td><code>string</code></td><td></td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isInheritable</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"attributeId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true\n}</code></pre><p><strong>Responses</strong></p><ul><li><p><code>200</code>: attribute updated</p><ul><li><code>application/json; charset=utf-8</code>: <code>Attribute</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attributeId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>label</code>, <code>relation</code>.</td></tr><tr><td><code>name</code></td><td><code>string</code></td><td></td></tr><tr><td><code>value</code></td><td><code>string</code></td><td></td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isInheritable</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>POST /refresh-note-ordering/{parentNoteId}</code></h3><p>notePositions in branches are not automatically pushed to connected clients and need a specific instruction. If you want your changes to be in effect immediately, call this service after setting branches' notePosition. Note that you need to supply \"parentNoteId\" of branch(es) with changed positions.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>parentNoteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>204</code>: note ordering will be asynchronously updated in all connected clients</p></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>GET /inbox/{date}</code></h3><p>returns an \"inbox\" note, into which note can be created. Date will be used depending on whether the inbox is a fixed note (identified with #inbox label) or a day note in a journal. A database with neither returns the root note, and ignores the date, rather than creating a journal to hold a day note.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>date</code> <br><em>required</em></td><td>path</td><td><code>string (date)</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: inbox note</p><ul><li><code>application/json; charset=utf-8</code>: <code>Note</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the note. Returned as \"[protected]\" for protected notes, since ETAPI cannot open a protected session.</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>attributes</code></td><td><code>AttributeList</code></td><td></td></tr><tr><td><code>parentNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>parentBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>Writable through PATCH, e.g. to restore a migrated note's date after its content was rewritten. The local dateModified is derived from it.</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>GET /calendar/days/{date}</code></h3><p>returns a day note for a given date. Gets created if doesn't exist.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>date</code> <br><em>required</em></td><td>path</td><td><code>string (date)</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: day note</p><ul><li><code>application/json; charset=utf-8</code>: <code>Note</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the note. Returned as \"[protected]\" for protected notes, since ETAPI cannot open a protected session.</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>attributes</code></td><td><code>AttributeList</code></td><td></td></tr><tr><td><code>parentNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>parentBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>Writable through PATCH, e.g. to restore a migrated note's date after its content was rewritten. The local dateModified is derived from it.</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>GET /calendar/week-first-day/{date}</code></h3><p>Get the day note starting the week</p><p>Returns the day note for the first day of the week containing the given date, honouring the configured first day of week. The note is created if it doesn't exist. This returns a day note, not a week note, so unlike /calendar/weeks/{week} it does not require the enableWeekNote label on the calendar root.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>date</code> <br><em>required</em></td><td>path</td><td><code>string (date)</code></td><td>Any date within the week, in the format YYYY-MM-DD.</td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: day note starting the week</p><ul><li><code>application/json; charset=utf-8</code>: <code>Note</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the note. Returned as \"[protected]\" for protected notes, since ETAPI cannot open a protected session.</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>attributes</code></td><td><code>AttributeList</code></td><td></td></tr><tr><td><code>parentNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>parentBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>Writable through PATCH, e.g. to restore a migrated note's date after its content was rewritten. The local dateModified is derived from it.</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>GET /calendar/weeks/{week}</code></h3><p>Get a week note</p><p>Returns a week note for a given ISO week (format YYYY-Www, e.g., 2025-W01). The note is created if it doesn't exist.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>week</code> <br><em>required</em></td><td>path</td><td><code>string</code></td><td>The ISO 8601 week identifier (YYYY-Www).</td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: week note</p><ul><li><code>application/json; charset=utf-8</code>: <code>Note</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the note. Returned as \"[protected]\" for protected notes, since ETAPI cannot open a protected session.</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>attributes</code></td><td><code>AttributeList</code></td><td></td></tr><tr><td><code>parentNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>parentBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>Writable through PATCH, e.g. to restore a migrated note's date after its content was rewritten. The local dateModified is derived from it.</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>GET /calendar/months/{month}</code></h3><p>Get a month note</p><p>Returns a month note for a given month (format YYYY-MM, e.g., 2022-02). The note is created if it doesn't exist.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>month</code> <br><em>required</em></td><td>path</td><td><code>string</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: month note</p><ul><li><code>application/json; charset=utf-8</code>: <code>Note</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the note. Returned as \"[protected]\" for protected notes, since ETAPI cannot open a protected session.</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>attributes</code></td><td><code>AttributeList</code></td><td></td></tr><tr><td><code>parentNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>parentBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>Writable through PATCH, e.g. to restore a migrated note's date after its content was rewritten. The local dateModified is derived from it.</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>GET /calendar/years/{year}</code></h3><p>Get a year note</p><p>Returns a year note for a given year (format YYYY, e.g., 2022). The note is created if it doesn't exist.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>year</code> <br><em>required</em></td><td>path</td><td><code>string</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: year note</p><ul><li><code>application/json; charset=utf-8</code>: <code>Note</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the note. Returned as \"[protected]\" for protected notes, since ETAPI cannot open a protected session.</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>attributes</code></td><td><code>AttributeList</code></td><td></td></tr><tr><td><code>parentNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>parentBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>Writable through PATCH, e.g. to restore a migrated note's date after its content was rewritten. The local dateModified is derived from it.</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>POST /auth/login</code></h3><p>get an ETAPI token based on password for further use with ETAPI</p><p><strong>Authorization</strong>: none</p><p><strong>Request body</strong> (required)</p><ul><li><code>application/json</code>: <code>object</code></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>password</code></td><td><code>string</code></td><td>user's password used to e.g. login to Trilium server and/or protect notes</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"password\": \"string\"\n}</code></pre><p><strong>Responses</strong></p><ul><li><p><code>201</code>: auth token</p><ul><li><code>application/json; charset=utf-8</code>: <code>object</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>authToken</code></td><td><code>string</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"authToken\": \"Bc4bFn0Ffiok_4NpbVCDnFz7B2WU+pdhW8B5Ne3DiR5wXrEyqdjgRIsk=\"\n}</code></pre><ul><li><p><code>429</code>: Client IP has been blacklisted because too many requests (possibly failed authentications) were made within a short time frame, try again later</p></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>POST /auth/logout</code></h3><p>logout (delete/deactivate) an ETAPI token</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Responses</strong></p><ul><li><p><code>204</code>: logout successful</p></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>GET /app-info</code></h3><p>returns information about the running Trilium instance</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Responses</strong></p><ul><li><p><code>200</code>: app info</p><ul><li><code>application/json; charset=utf-8</code>: <code>AppInfo</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>appVersion</code></td><td><code>string</code></td><td>Trilium version</td></tr><tr><td><code>dbVersion</code></td><td><code>integer (int32)</code></td><td>DB version</td></tr><tr><td><code>syncVersion</code></td><td><code>integer (int32)</code></td><td>Sync protocol version</td></tr><tr><td><code>buildDate</code></td><td><code>string (date-time)</code></td><td>build date</td></tr><tr><td><code>buildRevision</code></td><td><code>string</code></td><td>git build revision</td></tr><tr><td><code>dataDirectory</code></td><td><code>string</code></td><td>data directory where Trilium stores files</td></tr><tr><td><code>clipperProtocolVersion</code></td><td><code>string</code></td><td>version of the supported Trilium Web Clipper protocol</td></tr><tr><td><code>utcDateTime</code></td><td><code>string</code></td><td>current UTC date time</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"appVersion\": \"0.50.2\",\n \"dbVersion\": 194,\n \"syncVersion\": 25,\n \"buildDate\": \"2022-02-09T22:52:36+01:00\",\n \"buildRevision\": \"23daaa2387a0655685377f0a541d154aeec2aae8\",\n \"dataDirectory\": \"/home/user/data\",\n \"clipperProtocolVersion\": 1.1,\n \"utcDateTime\": \"2022-03-07T21:54:25.277Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>PUT /backup/{backupName}</code></h3><p>Create a database backup under a given name</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>backupName</code> <br><em>required</em></td><td>path</td><td><code>StringId</code></td><td>If the backupName is e.g. \"now\", then the backup will be written to \"backup-now.db\" file</td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>204</code>: backup has been created</p></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>GET /metrics</code></h3><p>Get instance metrics</p><p>Returns instance and database metrics for monitoring: note, attachment, revision, branch, attribute and blob counts, note and attachment type breakdowns, version information and database size. Counts only — no note titles, content or attributes.</p><p>The same data is served by GET /api/metrics to the web session.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>format</code></td><td>query</td><td><code>string</code></td><td>Response format. Defaults to Prometheus text. One of <code>prometheus</code>, <code>json</code>.</td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: instance metrics</p><ul><li><code>text/plain</code>: <code>string</code></li><li><code>application/json</code>: <code>Metrics</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>version</code></td><td><code>object</code></td><td></td></tr><tr><td><code>database</code></td><td><code>object</code></td><td></td></tr><tr><td><code>noteTypes</code></td><td><code>object</code></td><td>Number of active notes per note type</td></tr><tr><td><code>attachmentTypes</code></td><td><code>object</code></td><td>Number of active attachments per MIME type</td></tr><tr><td><code>statistics</code></td><td><code>object</code></td><td></td></tr><tr><td><code>timestamp</code></td><td><code>string</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"version\": {\n \"app\": \"0.99.3\",\n \"db\": 231,\n \"node\": \"v22.14.0\",\n \"sync\": 35,\n \"buildDate\": \"2024-09-07T18:36:34Z\",\n \"buildRevision\": \"7c0d6930fa8f20d269dcfbcbc8f636a25f6bb9a7\"\n },\n \"database\": {\n \"totalNotes\": 0,\n \"deletedNotes\": 0,\n \"activeNotes\": 0,\n \"protectedNotes\": 0,\n \"totalAttachments\": 0,\n \"deletedAttachments\": 0,\n \"activeAttachments\": 0,\n \"totalRevisions\": 0,\n \"totalBranches\": 0,\n \"totalAttributes\": 0,\n \"totalBlobs\": 0,\n \"totalEtapiTokens\": 0,\n \"totalRecentNotes\": 0\n },\n \"noteTypes\": {\n \"text\": 800,\n \"code\": 200\n },\n \"attachmentTypes\": {\n \"image/png\": 45,\n \"application/pdf\": 14\n },\n \"statistics\": {\n \"oldestNote\": \"string\",\n \"newestNote\": \"string\",\n \"lastModified\": \"string\",\n \"databaseSizeBytes\": 0\n },\n \"timestamp\": \"2024-12-01T12:00:00.000Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h2>Schemas</h2><h3><code>CreateNoteDef</code></h3><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>parentNoteId</code> <br><em>required</em></td><td><code>EntityId</code></td><td>Note ID of the parent note in the tree</td></tr><tr><td><code>title</code> <br><em>required</em></td><td><code>string</code></td><td></td></tr><tr><td><code>type</code> <br><em>required</em></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>book</code>, <code>relationMap</code>, <code>render</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td>this needs to be specified only for note types 'code', 'file', 'image'.</td></tr><tr><td><code>content</code> <br><em>required</em></td><td><code>string</code></td><td></td></tr><tr><td><code>notePosition</code></td><td><code>integer</code></td><td>Position of the note in the parent. Normal ordering is 10, 20, 30 ... So if you want to create a note on the first position, use e.g. 5, for second position 15, for last e.g. 1000000</td></tr><tr><td><code>prefix</code></td><td><code>string</code></td><td>Prefix is branch (placement) specific title prefix for the note. Let's say you have your note placed into two different places in the tree, but you want to change the title a bit in one of the placements. For this you can use prefix.</td></tr><tr><td><code>isExpanded</code></td><td><code>boolean</code></td><td>true if this note (as a folder) should appear expanded</td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>DON'T specify unless you want to force a specific noteId</td></tr><tr><td><code>branchId</code></td><td><code>EntityId</code></td><td>DON'T specify unless you want to force a specific branchId</td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td>Local timestap of the note creation. Specify only if you want to override the default (current datetime in the current timezone/offset).</td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td>UTC timestap of the note creation. Specify only if you want to override the default (current datetime).</td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>UTC timestamp of the note's last modification, e.g. to keep the date of a note being migrated from another application. The local dateModified is derived from it. Specify only if you want to override the default (current datetime).</td></tr></tbody></table></figure><h3><code>Note</code></h3><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the note. Returned as \"[protected]\" for protected notes, since ETAPI cannot open a protected session.</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>attributes</code></td><td><code>AttributeList</code></td><td></td></tr><tr><td><code>parentNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>parentBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>Writable through PATCH, e.g. to restore a migrated note's date after its content was rewritten. The local dateModified is derived from it.</td></tr></tbody></table></figure><h3><code>Branch</code></h3><p>Branch places the note into the tree, it represents the relationship between a parent note and child note</p><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>branchId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>parentNoteId</code></td><td><code>EntityId</code></td><td>identifies the parent note</td></tr><tr><td><code>prefix</code></td><td><code>string</code></td><td></td></tr><tr><td><code>notePosition</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isExpanded</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><h3><code>NoteWithBranch</code></h3><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>note</code></td><td><code>Note</code></td><td></td></tr><tr><td><code>branch</code></td><td><code>Branch</code></td><td>Branch places the note into the tree, it represents the relationship between a parent note and child note</td></tr></tbody></table></figure><h3><code>Attachment</code></h3><p>Attachment is owned by a note, has title and content</p><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attachmentId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>ownerId</code></td><td><code>EntityId</code></td><td>identifies the owner of the attachment, is either noteId or revisionId</td></tr><tr><td><code>role</code></td><td><code>string</code></td><td></td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the attachment. Returned as \"[protected]\" for protected attachments, since ETAPI cannot open a protected session.</td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateScheduledForErasureSince</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>contentLength</code></td><td><code>integer (int32)</code></td><td></td></tr></tbody></table></figure><h3><code>CreateAttachment</code></h3><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>ownerId</code></td><td><code>EntityId</code></td><td>identifies the owner of the attachment, is either noteId or revisionId</td></tr><tr><td><code>role</code></td><td><code>string</code></td><td></td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td></td></tr><tr><td><code>content</code></td><td><code>string</code></td><td>Text content of the attachment, stored as-is. To store binary content, create the attachment without it, then upload the data with <code>PUT /attachments/{attachmentId}/content</code>.</td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr></tbody></table></figure><h3><code>Attribute</code></h3><p>Attribute (Label, Relation) is a key-value record attached to a note.</p><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attributeId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>label</code>, <code>relation</code>.</td></tr><tr><td><code>name</code></td><td><code>string</code></td><td></td></tr><tr><td><code>value</code></td><td><code>string</code></td><td></td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isInheritable</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><h3><code>AttributeList</code></h3><p>Type: <code>array of Attribute</code></p><h3><code>SearchResponse</code></h3><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>results</code> <br><em>required</em></td><td><code>array of Note</code></td><td></td></tr><tr><td><code>debugInfo</code></td><td><code>object</code></td><td>debugging info on parsing the search query enabled with &amp;debug=true parameter</td></tr></tbody></table></figure><h3><code>EntityId</code></h3><p>Type: <code>string</code></p><h3><code>StringId</code></h3><p>Type: <code>string</code></p><h3><code>EntityIdList</code></h3><p>Type: <code>array of EntityId</code></p><h3><code>LocalDateTime</code></h3><p>Type: <code>string</code></p><h3><code>UtcDateTime</code></h3><p>Type: <code>string</code></p><h3><code>AppInfo</code></h3><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>appVersion</code></td><td><code>string</code></td><td>Trilium version</td></tr><tr><td><code>dbVersion</code></td><td><code>integer (int32)</code></td><td>DB version</td></tr><tr><td><code>syncVersion</code></td><td><code>integer (int32)</code></td><td>Sync protocol version</td></tr><tr><td><code>buildDate</code></td><td><code>string (date-time)</code></td><td>build date</td></tr><tr><td><code>buildRevision</code></td><td><code>string</code></td><td>git build revision</td></tr><tr><td><code>dataDirectory</code></td><td><code>string</code></td><td>data directory where Trilium stores files</td></tr><tr><td><code>clipperProtocolVersion</code></td><td><code>string</code></td><td>version of the supported Trilium Web Clipper protocol</td></tr><tr><td><code>utcDateTime</code></td><td><code>string</code></td><td>current UTC date time</td></tr></tbody></table></figure><h3><code>Error</code></h3><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><h3><code>Revision</code></h3><p>Revision represents a snapshot of note's title and content at some point in the past.</p><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>revisionId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>dateLastEdited</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateLastEdited</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>contentLength</code></td><td><code>integer (int32)</code></td><td></td></tr></tbody></table></figure><h3><code>RecentChange</code></h3><p>Represents a recent change event (creation, modification, or deletion).</p><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title at the time of the change (may be \"[protected]\" for protected notes)</td></tr><tr><td><code>current_title</code></td><td><code>string</code></td><td>Current title of the note (may be \"[protected]\" for protected notes)</td></tr><tr><td><code>current_isDeleted</code></td><td><code>boolean</code></td><td>Whether the note is currently deleted</td></tr><tr><td><code>current_deleteId</code></td><td><code>string</code></td><td>Delete ID if the note is deleted</td></tr><tr><td><code>current_isProtected</code></td><td><code>boolean</code></td><td>Whether the note is protected</td></tr><tr><td><code>utcDate</code></td><td><code>UtcDateTime</code></td><td>UTC timestamp of the change</td></tr><tr><td><code>date</code></td><td><code>LocalDateTime</code></td><td>Local timestamp of the change</td></tr><tr><td><code>canBeUndeleted</code></td><td><code>boolean</code></td><td>Whether the note can be undeleted (only present for deleted notes)</td></tr></tbody></table></figure><h3><code>Metrics</code></h3><p>Instance and database metrics, as served by GET /etapi/metrics?format=json</p><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>version</code></td><td><code>object</code></td><td></td></tr><tr><td><code>database</code></td><td><code>object</code></td><td></td></tr><tr><td><code>noteTypes</code></td><td><code>object</code></td><td>Number of active notes per note type</td></tr><tr><td><code>attachmentTypes</code></td><td><code>object</code></td><td>Number of active attachments per MIME type</td></tr><tr><td><code>statistics</code></td><td><code>object</code></td><td></td></tr><tr><td><code>timestamp</code></td><td><code>string</code></td><td></td></tr></tbody></table></figure>",
+ "_help_9qPsTWBorUhQ": "<p>External Trilium API</p><h2>Authentication</h2><h3><code>EtapiTokenAuth</code></h3><p>API key in the <code>Authorization</code> header.</p><h3><code>EtapiBasicAuth</code></h3><p>HTTP <code>basic</code> authentication.</p><p>Basic Auth where username is arbitrary string (e.g. \"trilium\", not checked), username is the ETAPI token. To emphasize, do not use Trilium password here (won't work), only the generated ETAPI token (from Options -&gt; ETAPI)</p><h2>Endpoints</h2><h3><code>createNote</code></h3><p><code>POST /create-note</code></p><p>Create a note and place it into the note tree</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Request body</strong> (required)</p><ul><li><code>application/json</code>: <code>CreateNoteDef</code></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>parentNoteId</code> <br><em>required</em></td><td><code>EntityId</code></td><td>Note ID of the parent note in the tree</td></tr><tr><td><code>title</code> <br><em>required</em></td><td><code>string</code></td><td></td></tr><tr><td><code>type</code> <br><em>required</em></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>book</code>, <code>relationMap</code>, <code>render</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td>this needs to be specified only for note types 'code', 'file', 'image'.</td></tr><tr><td><code>content</code> <br><em>required</em></td><td><code>string</code></td><td></td></tr><tr><td><code>notePosition</code></td><td><code>integer</code></td><td>Position of the note in the parent. Normal ordering is 10, 20, 30 ... So if you want to create a note on the first position, use e.g. 5, for second position 15, for last e.g. 1000000</td></tr><tr><td><code>prefix</code></td><td><code>string</code></td><td>Prefix is branch (placement) specific title prefix for the note. Let's say you have your note placed into two different places in the tree, but you want to change the title a bit in one of the placements. For this you can use prefix.</td></tr><tr><td><code>isExpanded</code></td><td><code>boolean</code></td><td>true if this note (as a folder) should appear expanded</td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>DON'T specify unless you want to force a specific noteId</td></tr><tr><td><code>branchId</code></td><td><code>EntityId</code></td><td>DON'T specify unless you want to force a specific branchId</td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td>Local timestap of the note creation. Specify only if you want to override the default (current datetime in the current timezone/offset).</td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td>UTC timestap of the note creation. Specify only if you want to override the default (current datetime).</td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>UTC timestamp of the note's last modification, e.g. to keep the date of a note being migrated from another application. The local dateModified is derived from it. Specify only if you want to override the default (current datetime).</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"parentNoteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"application/json\",\n \"content\": \"string\",\n \"notePosition\": 0,\n \"prefix\": \"string\",\n \"isExpanded\": true,\n \"noteId\": \"evnnmvHTCgIn\",\n \"branchId\": \"evnnmvHTCgIn\",\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><p><strong>Responses</strong></p><ul><li><p><code>201</code>: note created</p><ul><li><code>application/json; charset=utf-8</code>: <code>NoteWithBranch</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>note</code></td><td><code>Note</code></td><td></td></tr><tr><td><code>branch</code></td><td><code>Branch</code></td><td>Branch places the note into the tree, it represents the relationship between a parent note and child note</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"note\": {\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n },\n \"branch\": {\n \"branchId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"parentNoteId\": \"evnnmvHTCgIn\",\n \"prefix\": \"string\",\n \"notePosition\": 0,\n \"isExpanded\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>searchNotes</code></h3><p><code>GET /notes</code></p><p>Search notes</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>search</code> <br><em>required</em></td><td>query</td><td><code>string</code></td><td>search query string as described in <a href=\"https://triliumnext.github.io/Docs/Wiki/search.html\">https://triliumnext.github.io/Docs/Wiki/search.html</a></td></tr><tr><td><code>fastSearch</code></td><td>query</td><td><code>boolean</code></td><td>enable fast search (fulltext doesn't look into content)</td></tr><tr><td><code>includeArchivedNotes</code></td><td>query</td><td><code>boolean</code></td><td>search by default ignores archived notes. Set to 'true' to includes archived notes into search results.</td></tr><tr><td><code>ancestorNoteId</code></td><td>query</td><td><code>EntityId</code></td><td>search only in a subtree identified by the subtree noteId. By default whole tree is searched.</td></tr><tr><td><code>ancestorDepth</code></td><td>query</td><td><code>string</code></td><td>define how deep in the tree should the notes be searched</td></tr><tr><td><code>orderBy</code></td><td>query</td><td><code>string</code></td><td>name of the property/label to order search results by</td></tr><tr><td><code>orderDirection</code></td><td>query</td><td><code>string</code></td><td>order direction, ascending or descending. One of <code>asc</code>, <code>desc</code>.</td></tr><tr><td><code>limit</code></td><td>query</td><td><code>integer</code></td><td>limit the number of results you want to receive</td></tr><tr><td><code>debug</code></td><td>query</td><td><code>boolean</code></td><td>set to true to get debug information in the response (search query parsing)</td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: search response</p><ul><li><code>application/json; charset=utf-8</code>: <code>SearchResponse</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>results</code> <br><em>required</em></td><td><code>array of Note</code></td><td></td></tr><tr><td><code>debugInfo</code></td><td><code>object</code></td><td>debugging info on parsing the search query enabled with &amp;debug=true parameter</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"results\": [\n {\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"debugInfo\": {}\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>getNoteById</code></h3><p><code>GET /notes/{noteId}</code></p><p>Returns a note identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: note response</p><ul><li><code>application/json; charset=utf-8</code>: <code>Note</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the note. Returned as \"[protected]\" for protected notes, since ETAPI cannot open a protected session.</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>attributes</code></td><td><code>AttributeList</code></td><td></td></tr><tr><td><code>parentNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>parentBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>Writable through PATCH, e.g. to restore a migrated note's date after its content was rewritten. The local dateModified is derived from it.</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>deleteNoteById</code></h3><p><code>DELETE /notes/{noteId}</code></p><p>deletes a single note based on the noteId supplied</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>204</code>: note deleted</p></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>patchNoteById</code></h3><p><code>PATCH /notes/{noteId}</code></p><p>patch a note identified by the noteId with changes in the body</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Request body</strong> (required)</p><ul><li><code>application/json</code>: <code>Note</code></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the note. Returned as \"[protected]\" for protected notes, since ETAPI cannot open a protected session.</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>attributes</code></td><td><code>AttributeList</code></td><td></td></tr><tr><td><code>parentNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>parentBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>Writable through PATCH, e.g. to restore a migrated note's date after its content was rewritten. The local dateModified is derived from it.</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"blobId\": \"string\",\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><p><strong>Responses</strong></p><ul><li><p><code>200</code>: note updated</p><ul><li><code>application/json; charset=utf-8</code>: <code>Note</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the note. Returned as \"[protected]\" for protected notes, since ETAPI cannot open a protected session.</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>attributes</code></td><td><code>AttributeList</code></td><td></td></tr><tr><td><code>parentNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>parentBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>Writable through PATCH, e.g. to restore a migrated note's date after its content was rewritten. The local dateModified is derived from it.</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>getNoteContent</code></h3><p><code>GET /notes/{noteId}/content</code></p><p>Returns note content identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: note content, served with the note's MIME type as <code>Content-Type</code></p><ul><li><code>*/*</code>: <code>string (binary)</code></li></ul></li></ul><h3><code>putNoteContentById</code></h3><p><code>PUT /notes/{noteId}/content</code></p><p>Updates note content identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Request body</strong> (required)</p><p>New content of the note. Send text (such as the HTML of a text note) as <code>text/plain</code> and binary data (such as the file of an image or file note) as <code>application/octet-stream</code>; other content types are not accepted.</p><ul><li><code>text/plain</code>: <code>string</code></li><li><code>application/octet-stream</code>: <code>string (binary)</code></li></ul><p><strong>Responses</strong></p><ul><li><code>204</code>: note content updated</li></ul><h3><code>exportNoteSubtree</code></h3><p><code>GET /notes/{noteId}/export</code></p><p>Exports ZIP file export of a given note subtree. To export whole document, use \"root\" for noteId</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr><tr><td><code>format</code></td><td>query</td><td><code>any</code></td><td>One of <code>html</code>, <code>markdown</code>, <code>share</code>.</td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: export ZIP file</p><ul><li><code>application/zip</code>: <code>string (binary)</code></li></ul></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>importZip</code></h3><p><code>POST /notes/{noteId}/import</code></p><p>Imports ZIP file into a given note.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>201</code>: note created</p><ul><li><code>application/json; charset=utf-8</code>: <code>NoteWithBranch</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>note</code></td><td><code>Note</code></td><td></td></tr><tr><td><code>branch</code></td><td><code>Branch</code></td><td>Branch places the note into the tree, it represents the relationship between a parent note and child note</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"note\": {\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n },\n \"branch\": {\n \"branchId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"parentNoteId\": \"evnnmvHTCgIn\",\n \"prefix\": \"string\",\n \"notePosition\": 0,\n \"isExpanded\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>createRevision</code></h3><p><code>POST /notes/{noteId}/revision</code></p><p>Create a note revision for the given note</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr><tr><td><code>format</code></td><td>query</td><td><code>any</code></td><td>One of <code>html</code>, <code>markdown</code>.</td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>204</code>: revision has been created</p></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>getNoteRevisions</code></h3><p><code>GET /notes/{noteId}/revisions</code></p><p>Returns the revisions of a note identified by its ID. Protected revisions are omitted, since they cannot be read through ETAPI individually either.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: list of revisions</p><ul><li><code>application/json; charset=utf-8</code>: <code>array of Revision</code></li></ul></li></ul><pre><code class=\"language-application-json\">[\n {\n \"revisionId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"title\": \"string\",\n \"blobId\": \"string\",\n \"dateLastEdited\": \"2021-12-31 20:18:11.930+0100\",\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateLastEdited\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\",\n \"contentLength\": 0\n }\n]</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>getNoteAttachments</code></h3><p><code>GET /notes/{noteId}/attachments</code></p><p>Returns all attachments for a note identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: list of attachments</p><ul><li><code>application/json; charset=utf-8</code>: <code>array of Attachment</code></li></ul></li></ul><pre><code class=\"language-application-json\">[\n {\n \"attachmentId\": \"evnnmvHTCgIn\",\n \"ownerId\": \"evnnmvHTCgIn\",\n \"role\": \"string\",\n \"mime\": \"string\",\n \"title\": \"string\",\n \"position\": 0,\n \"blobId\": \"string\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateScheduledForErasureSince\": \"2021-12-31 19:18:11.930Z\",\n \"contentLength\": 0\n }\n]</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>undeleteNote</code></h3><p><code>POST /notes/{noteId}/undelete</code></p><p>Restore a deleted note. The note must be deleted and must have at least one undeleted parent.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: note restored successfully</p><ul><li><code>application/json; charset=utf-8</code>: <code>object</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>success</code></td><td><code>boolean</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"success\": true\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>getNoteHistory</code></h3><p><code>GET /notes/history</code></p><p>Returns recent changes including note creations, modifications, and deletions</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>ancestorNoteId</code></td><td>query</td><td><code>EntityId</code></td><td>Limit changes to a subtree identified by this note ID. Defaults to \"root\" (all notes).</td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: list of recent changes</p><ul><li><code>application/json; charset=utf-8</code>: <code>array of RecentChange</code></li></ul></li></ul><pre><code class=\"language-application-json\">[\n {\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"current_title\": \"string\",\n \"current_isDeleted\": true,\n \"current_deleteId\": \"string\",\n \"current_isProtected\": true,\n \"utcDate\": \"2021-12-31 19:18:11.930Z\",\n \"date\": \"2021-12-31 20:18:11.930+0100\",\n \"canBeUndeleted\": true\n }\n]</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>getRevisionById</code></h3><p><code>GET /revisions/{revisionId}</code></p><p>Returns a revision identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>revisionId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: revision response</p><ul><li><code>application/json; charset=utf-8</code>: <code>Revision</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>revisionId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>dateLastEdited</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateLastEdited</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>contentLength</code></td><td><code>integer (int32)</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"revisionId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"title\": \"string\",\n \"blobId\": \"string\",\n \"dateLastEdited\": \"2021-12-31 20:18:11.930+0100\",\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateLastEdited\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\",\n \"contentLength\": 0\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>getRevisionContent</code></h3><p><code>GET /revisions/{revisionId}/content</code></p><p>Returns revision content identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>revisionId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: revision content response</p><ul><li><code>text/html</code>: <code>string</code></li></ul></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>postBranch</code></h3><p><code>POST /branches</code></p><p>Create a branch (clone a note to a different location in the tree). In case there is a branch between parent note and child note already, then this will update the existing branch with prefix, notePosition and isExpanded.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Request body</strong> (required)</p><ul><li><code>application/json</code>: <code>Branch</code></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>branchId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>parentNoteId</code></td><td><code>EntityId</code></td><td>identifies the parent note</td></tr><tr><td><code>prefix</code></td><td><code>string</code></td><td></td></tr><tr><td><code>notePosition</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isExpanded</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"branchId\": \"evnnmvHTCgIn\",\n \"prefix\": \"string\",\n \"notePosition\": 0,\n \"isExpanded\": true\n}</code></pre><p><strong>Responses</strong></p><ul><li><p><code>200</code>: branch updated (branch between parent note and child note already existed)</p><ul><li><code>application/json; charset=utf-8</code>: <code>Branch</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>branchId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>parentNoteId</code></td><td><code>EntityId</code></td><td>identifies the parent note</td></tr><tr><td><code>prefix</code></td><td><code>string</code></td><td></td></tr><tr><td><code>notePosition</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isExpanded</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"branchId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"parentNoteId\": \"evnnmvHTCgIn\",\n \"prefix\": \"string\",\n \"notePosition\": 0,\n \"isExpanded\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>201</code>: branch created</p><ul><li><code>application/json; charset=utf-8</code>: <code>Branch</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>branchId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>parentNoteId</code></td><td><code>EntityId</code></td><td>identifies the parent note</td></tr><tr><td><code>prefix</code></td><td><code>string</code></td><td></td></tr><tr><td><code>notePosition</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isExpanded</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"branchId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"parentNoteId\": \"evnnmvHTCgIn\",\n \"prefix\": \"string\",\n \"notePosition\": 0,\n \"isExpanded\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>getBranchById</code></h3><p><code>GET /branches/{branchId}</code></p><p>Returns a branch identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>branchId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: branch response</p><ul><li><code>application/json; charset=utf-8</code>: <code>Branch</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>branchId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>parentNoteId</code></td><td><code>EntityId</code></td><td>identifies the parent note</td></tr><tr><td><code>prefix</code></td><td><code>string</code></td><td></td></tr><tr><td><code>notePosition</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isExpanded</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"branchId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"parentNoteId\": \"evnnmvHTCgIn\",\n \"prefix\": \"string\",\n \"notePosition\": 0,\n \"isExpanded\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>deleteBranchById</code></h3><p><code>DELETE /branches/{branchId}</code></p><p>deletes a branch based on the branchId supplied. If this is the last branch of the (child) note, then the note is deleted as well.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>branchId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>204</code>: branch deleted</p></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>patchBranchById</code></h3><p><code>PATCH /branches/{branchId}</code></p><p>patch a branch identified by the branchId with changes in the body. Only prefix and notePosition can be updated. If you want to update other properties, you need to delete the old branch and create a new one.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>branchId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Request body</strong> (required)</p><ul><li><code>application/json</code>: <code>Branch</code></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>branchId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>parentNoteId</code></td><td><code>EntityId</code></td><td>identifies the parent note</td></tr><tr><td><code>prefix</code></td><td><code>string</code></td><td></td></tr><tr><td><code>notePosition</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isExpanded</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"branchId\": \"evnnmvHTCgIn\",\n \"prefix\": \"string\",\n \"notePosition\": 0,\n \"isExpanded\": true\n}</code></pre><p><strong>Responses</strong></p><ul><li><p><code>200</code>: branch updated</p><ul><li><code>application/json; charset=utf-8</code>: <code>Branch</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>branchId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>parentNoteId</code></td><td><code>EntityId</code></td><td>identifies the parent note</td></tr><tr><td><code>prefix</code></td><td><code>string</code></td><td></td></tr><tr><td><code>notePosition</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isExpanded</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"branchId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"parentNoteId\": \"evnnmvHTCgIn\",\n \"prefix\": \"string\",\n \"notePosition\": 0,\n \"isExpanded\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>postAttachment</code></h3><p><code>POST /attachments</code></p><p>create an attachment</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Request body</strong> (required)</p><ul><li><code>application/json</code>: <code>CreateAttachment</code></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>ownerId</code></td><td><code>EntityId</code></td><td>identifies the owner of the attachment, is either noteId or revisionId</td></tr><tr><td><code>role</code></td><td><code>string</code></td><td></td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td></td></tr><tr><td><code>content</code></td><td><code>string</code></td><td>Text content of the attachment, stored as-is. To store binary content, create the attachment without it, then upload the data with <code>PUT /attachments/{attachmentId}/content</code>.</td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"ownerId\": \"evnnmvHTCgIn\",\n \"role\": \"string\",\n \"mime\": \"string\",\n \"title\": \"string\",\n \"content\": \"string\",\n \"position\": 0\n}</code></pre><p><strong>Responses</strong></p><ul><li><p><code>201</code>: attachment created</p><ul><li><code>application/json; charset=utf-8</code>: <code>Attachment</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attachmentId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>ownerId</code></td><td><code>EntityId</code></td><td>identifies the owner of the attachment, is either noteId or revisionId</td></tr><tr><td><code>role</code></td><td><code>string</code></td><td></td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the attachment. Returned as \"[protected]\" for protected attachments, since ETAPI cannot open a protected session.</td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateScheduledForErasureSince</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>contentLength</code></td><td><code>integer (int32)</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"attachmentId\": \"evnnmvHTCgIn\",\n \"ownerId\": \"evnnmvHTCgIn\",\n \"role\": \"string\",\n \"mime\": \"string\",\n \"title\": \"string\",\n \"position\": 0,\n \"blobId\": \"string\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateScheduledForErasureSince\": \"2021-12-31 19:18:11.930Z\",\n \"contentLength\": 0\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>getAttachmentById</code></h3><p><code>GET /attachments/{attachmentId}</code></p><p>Returns an attachment identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attachmentId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: attachment response</p><ul><li><code>application/json; charset=utf-8</code>: <code>Attachment</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attachmentId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>ownerId</code></td><td><code>EntityId</code></td><td>identifies the owner of the attachment, is either noteId or revisionId</td></tr><tr><td><code>role</code></td><td><code>string</code></td><td></td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the attachment. Returned as \"[protected]\" for protected attachments, since ETAPI cannot open a protected session.</td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateScheduledForErasureSince</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>contentLength</code></td><td><code>integer (int32)</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"attachmentId\": \"evnnmvHTCgIn\",\n \"ownerId\": \"evnnmvHTCgIn\",\n \"role\": \"string\",\n \"mime\": \"string\",\n \"title\": \"string\",\n \"position\": 0,\n \"blobId\": \"string\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateScheduledForErasureSince\": \"2021-12-31 19:18:11.930Z\",\n \"contentLength\": 0\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>deleteAttachmentById</code></h3><p><code>DELETE /attachments/{attachmentId}</code></p><p>deletes an attachment based on the attachmentId supplied.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attachmentId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>204</code>: attachment deleted</p></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>patchAttachmentById</code></h3><p><code>PATCH /attachments/{attachmentId}</code></p><p>patch an attachment identified by the attachmentId with changes in the body. Only role, mime, title, and position are patchable.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attachmentId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Request body</strong> (required)</p><ul><li><code>application/json</code>: <code>Attachment</code></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attachmentId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>ownerId</code></td><td><code>EntityId</code></td><td>identifies the owner of the attachment, is either noteId or revisionId</td></tr><tr><td><code>role</code></td><td><code>string</code></td><td></td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the attachment. Returned as \"[protected]\" for protected attachments, since ETAPI cannot open a protected session.</td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateScheduledForErasureSince</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>contentLength</code></td><td><code>integer (int32)</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"ownerId\": \"evnnmvHTCgIn\",\n \"role\": \"string\",\n \"mime\": \"string\",\n \"title\": \"string\",\n \"position\": 0,\n \"blobId\": \"string\",\n \"contentLength\": 0\n}</code></pre><p><strong>Responses</strong></p><ul><li><p><code>200</code>: attribute updated</p><ul><li><code>application/json; charset=utf-8</code>: <code>Attachment</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attachmentId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>ownerId</code></td><td><code>EntityId</code></td><td>identifies the owner of the attachment, is either noteId or revisionId</td></tr><tr><td><code>role</code></td><td><code>string</code></td><td></td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the attachment. Returned as \"[protected]\" for protected attachments, since ETAPI cannot open a protected session.</td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateScheduledForErasureSince</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>contentLength</code></td><td><code>integer (int32)</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"attachmentId\": \"evnnmvHTCgIn\",\n \"ownerId\": \"evnnmvHTCgIn\",\n \"role\": \"string\",\n \"mime\": \"string\",\n \"title\": \"string\",\n \"position\": 0,\n \"blobId\": \"string\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateScheduledForErasureSince\": \"2021-12-31 19:18:11.930Z\",\n \"contentLength\": 0\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>getAttachmentContent</code></h3><p><code>GET /attachments/{attachmentId}/content</code></p><p>Returns attachment content identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attachmentId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: attachment content, served with the attachment's MIME type as <code>Content-Type</code></p><ul><li><code>*/*</code>: <code>string (binary)</code></li></ul></li></ul><h3><code>putAttachmentContentById</code></h3><p><code>PUT /attachments/{attachmentId}/content</code></p><p>Updates attachment content identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attachmentId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Request body</strong> (required)</p><p>New content of the attachment. Send text as <code>text/plain</code> and binary data (such as an image or a PDF) as <code>application/octet-stream</code>; other content types are not accepted.</p><ul><li><code>text/plain</code>: <code>string</code></li><li><code>application/octet-stream</code>: <code>string (binary)</code></li></ul><p><strong>Responses</strong></p><ul><li><code>204</code>: attachment content updated</li></ul><h3><code>postAttribute</code></h3><p><code>POST /attributes</code></p><p>create an attribute for a given note</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Request body</strong> (required)</p><ul><li><code>application/json</code>: <code>Attribute</code></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attributeId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>label</code>, <code>relation</code>.</td></tr><tr><td><code>name</code></td><td><code>string</code></td><td></td></tr><tr><td><code>value</code></td><td><code>string</code></td><td></td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isInheritable</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"attributeId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true\n}</code></pre><p><strong>Responses</strong></p><ul><li><p><code>201</code>: attribute created</p><ul><li><code>application/json; charset=utf-8</code>: <code>Attribute</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attributeId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>label</code>, <code>relation</code>.</td></tr><tr><td><code>name</code></td><td><code>string</code></td><td></td></tr><tr><td><code>value</code></td><td><code>string</code></td><td></td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isInheritable</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>getAttributeById</code></h3><p><code>GET /attributes/{attributeId}</code></p><p>Returns an attribute identified by its ID</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attributeId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: attribute response</p><ul><li><code>application/json; charset=utf-8</code>: <code>Attribute</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attributeId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>label</code>, <code>relation</code>.</td></tr><tr><td><code>name</code></td><td><code>string</code></td><td></td></tr><tr><td><code>value</code></td><td><code>string</code></td><td></td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isInheritable</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>deleteAttributeById</code></h3><p><code>DELETE /attributes/{attributeId}</code></p><p>deletes an attribute based on the attributeId supplied.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attributeId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>204</code>: attribute deleted</p></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>patchAttributeById</code></h3><p><code>PATCH /attributes/{attributeId}</code></p><p>patch an attribute identified by the attributeId with changes in the body. For labels, only value and position can be updated. For relations, only position can be updated. If you want to modify other properties, you need to delete the old attribute and create a new one.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attributeId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Request body</strong> (required)</p><ul><li><code>application/json</code>: <code>Attribute</code></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attributeId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>label</code>, <code>relation</code>.</td></tr><tr><td><code>name</code></td><td><code>string</code></td><td></td></tr><tr><td><code>value</code></td><td><code>string</code></td><td></td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isInheritable</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"attributeId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true\n}</code></pre><p><strong>Responses</strong></p><ul><li><p><code>200</code>: attribute updated</p><ul><li><code>application/json; charset=utf-8</code>: <code>Attribute</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attributeId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>label</code>, <code>relation</code>.</td></tr><tr><td><code>name</code></td><td><code>string</code></td><td></td></tr><tr><td><code>value</code></td><td><code>string</code></td><td></td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isInheritable</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>postRefreshNoteOrdering</code></h3><p><code>POST /refresh-note-ordering/{parentNoteId}</code></p><p>notePositions in branches are not automatically pushed to connected clients and need a specific instruction. If you want your changes to be in effect immediately, call this service after setting branches' notePosition. Note that you need to supply \"parentNoteId\" of branch(es) with changed positions.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>parentNoteId</code> <br><em>required</em></td><td>path</td><td><code>EntityId</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>204</code>: note ordering will be asynchronously updated in all connected clients</p></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>getInboxNote</code></h3><p><code>GET /inbox/{date}</code></p><p>returns an \"inbox\" note, into which note can be created. Date will be used depending on whether the inbox is a fixed note (identified with #inbox label) or a day note in a journal. A database with neither returns the root note, and ignores the date, rather than creating a journal to hold a day note.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>date</code> <br><em>required</em></td><td>path</td><td><code>string (date)</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: inbox note</p><ul><li><code>application/json; charset=utf-8</code>: <code>Note</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the note. Returned as \"[protected]\" for protected notes, since ETAPI cannot open a protected session.</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>attributes</code></td><td><code>AttributeList</code></td><td></td></tr><tr><td><code>parentNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>parentBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>Writable through PATCH, e.g. to restore a migrated note's date after its content was rewritten. The local dateModified is derived from it.</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>getDayNote</code></h3><p><code>GET /calendar/days/{date}</code></p><p>returns a day note for a given date. Gets created if doesn't exist.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>date</code> <br><em>required</em></td><td>path</td><td><code>string (date)</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: day note</p><ul><li><code>application/json; charset=utf-8</code>: <code>Note</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the note. Returned as \"[protected]\" for protected notes, since ETAPI cannot open a protected session.</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>attributes</code></td><td><code>AttributeList</code></td><td></td></tr><tr><td><code>parentNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>parentBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>Writable through PATCH, e.g. to restore a migrated note's date after its content was rewritten. The local dateModified is derived from it.</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3>Get the day note starting the week</h3><p><code>GET /calendar/week-first-day/{date}</code></p><p>Returns the day note for the first day of the week containing the given date, honouring the configured first day of week. The note is created if it doesn't exist. This returns a day note, not a week note, so unlike /calendar/weeks/{week} it does not require the enableWeekNote label on the calendar root.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>date</code> <br><em>required</em></td><td>path</td><td><code>string (date)</code></td><td>Any date within the week, in the format YYYY-MM-DD.</td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: day note starting the week</p><ul><li><code>application/json; charset=utf-8</code>: <code>Note</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the note. Returned as \"[protected]\" for protected notes, since ETAPI cannot open a protected session.</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>attributes</code></td><td><code>AttributeList</code></td><td></td></tr><tr><td><code>parentNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>parentBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>Writable through PATCH, e.g. to restore a migrated note's date after its content was rewritten. The local dateModified is derived from it.</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3>Get a week note</h3><p><code>GET /calendar/weeks/{week}</code></p><p>Returns a week note for a given ISO week (format YYYY-Www, e.g., 2025-W01). The note is created if it doesn't exist.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>week</code> <br><em>required</em></td><td>path</td><td><code>string</code></td><td>The ISO 8601 week identifier (YYYY-Www).</td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: week note</p><ul><li><code>application/json; charset=utf-8</code>: <code>Note</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the note. Returned as \"[protected]\" for protected notes, since ETAPI cannot open a protected session.</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>attributes</code></td><td><code>AttributeList</code></td><td></td></tr><tr><td><code>parentNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>parentBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>Writable through PATCH, e.g. to restore a migrated note's date after its content was rewritten. The local dateModified is derived from it.</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3>Get a month note</h3><p><code>GET /calendar/months/{month}</code></p><p>Returns a month note for a given month (format YYYY-MM, e.g., 2022-02). The note is created if it doesn't exist.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>month</code> <br><em>required</em></td><td>path</td><td><code>string</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: month note</p><ul><li><code>application/json; charset=utf-8</code>: <code>Note</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the note. Returned as \"[protected]\" for protected notes, since ETAPI cannot open a protected session.</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>attributes</code></td><td><code>AttributeList</code></td><td></td></tr><tr><td><code>parentNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>parentBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>Writable through PATCH, e.g. to restore a migrated note's date after its content was rewritten. The local dateModified is derived from it.</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3>Get a year note</h3><p><code>GET /calendar/years/{year}</code></p><p>Returns a year note for a given year (format YYYY, e.g., 2022). The note is created if it doesn't exist.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>year</code> <br><em>required</em></td><td>path</td><td><code>string</code></td><td></td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: year note</p><ul><li><code>application/json; charset=utf-8</code>: <code>Note</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the note. Returned as \"[protected]\" for protected notes, since ETAPI cannot open a protected session.</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>attributes</code></td><td><code>AttributeList</code></td><td></td></tr><tr><td><code>parentNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>parentBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>Writable through PATCH, e.g. to restore a migrated note's date after its content was rewritten. The local dateModified is derived from it.</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"noteId\": \"evnnmvHTCgIn\",\n \"title\": \"string\",\n \"type\": \"text\",\n \"mime\": \"string\",\n \"isProtected\": true,\n \"blobId\": \"string\",\n \"attributes\": [\n {\n \"attributeId\": \"evnnmvHTCgIn\",\n \"noteId\": \"evnnmvHTCgIn\",\n \"type\": \"label\",\n \"name\": \"shareCss\",\n \"value\": \"string\",\n \"position\": 0,\n \"isInheritable\": true,\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n }\n ],\n \"parentNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childNoteIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"parentBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"childBranchIds\": [\n \"evnnmvHTCgIn\"\n ],\n \"dateCreated\": \"2021-12-31 20:18:11.930+0100\",\n \"dateModified\": \"2021-12-31 20:18:11.930+0100\",\n \"utcDateCreated\": \"2021-12-31 19:18:11.930Z\",\n \"utcDateModified\": \"2021-12-31 19:18:11.930Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>login</code></h3><p><code>POST /auth/login</code></p><p>get an ETAPI token based on password for further use with ETAPI</p><p><strong>Authorization</strong>: none</p><p><strong>Request body</strong> (required)</p><ul><li><code>application/json</code>: <code>object</code></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>password</code></td><td><code>string</code></td><td>user's password used to e.g. login to Trilium server and/or protect notes</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"password\": \"string\"\n}</code></pre><p><strong>Responses</strong></p><ul><li><p><code>201</code>: auth token</p><ul><li><code>application/json; charset=utf-8</code>: <code>object</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>authToken</code></td><td><code>string</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"authToken\": \"Bc4bFn0Ffiok_4NpbVCDnFz7B2WU+pdhW8B5Ne3DiR5wXrEyqdjgRIsk=\"\n}</code></pre><ul><li><p><code>429</code>: Client IP has been blacklisted because too many requests (possibly failed authentications) were made within a short time frame, try again later</p></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>logout</code></h3><p><code>POST /auth/logout</code></p><p>logout (delete/deactivate) an ETAPI token</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Responses</strong></p><ul><li><p><code>204</code>: logout successful</p></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>getAppInfo</code></h3><p><code>GET /app-info</code></p><p>returns information about the running Trilium instance</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Responses</strong></p><ul><li><p><code>200</code>: app info</p><ul><li><code>application/json; charset=utf-8</code>: <code>AppInfo</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>appVersion</code></td><td><code>string</code></td><td>Trilium version</td></tr><tr><td><code>dbVersion</code></td><td><code>integer (int32)</code></td><td>DB version</td></tr><tr><td><code>syncVersion</code></td><td><code>integer (int32)</code></td><td>Sync protocol version</td></tr><tr><td><code>buildDate</code></td><td><code>string (date-time)</code></td><td>build date</td></tr><tr><td><code>buildRevision</code></td><td><code>string</code></td><td>git build revision</td></tr><tr><td><code>dataDirectory</code></td><td><code>string</code></td><td>data directory where Trilium stores files</td></tr><tr><td><code>clipperProtocolVersion</code></td><td><code>string</code></td><td>version of the supported Trilium Web Clipper protocol</td></tr><tr><td><code>utcDateTime</code></td><td><code>string</code></td><td>current UTC date time</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"appVersion\": \"0.50.2\",\n \"dbVersion\": 194,\n \"syncVersion\": 25,\n \"buildDate\": \"2022-02-09T22:52:36+01:00\",\n \"buildRevision\": \"23daaa2387a0655685377f0a541d154aeec2aae8\",\n \"dataDirectory\": \"/home/user/data\",\n \"clipperProtocolVersion\": 1.1,\n \"utcDateTime\": \"2022-03-07T21:54:25.277Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3><code>createBackup</code></h3><p><code>PUT /backup/{backupName}</code></p><p>Create a database backup under a given name</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>backupName</code> <br><em>required</em></td><td>path</td><td><code>StringId</code></td><td>If the backupName is e.g. \"now\", then the backup will be written to \"backup-now.db\" file</td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>204</code>: backup has been created</p></li><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h3>Get instance metrics</h3><p><code>GET /metrics</code></p><p>Returns instance and database metrics for monitoring: note, attachment, revision, branch, attribute and blob counts, note and attachment type breakdowns, version information and database size. Counts only — no note titles, content or attributes.</p><p>The same data is served by GET /api/metrics to the web session.</p><p><strong>Authorization</strong>: <code>EtapiTokenAuth</code> or <code>EtapiBasicAuth</code></p><p><strong>Parameters</strong></p><figure class=\"table\"><table><thead><tr><th>Name</th><th>In</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>format</code></td><td>query</td><td><code>string</code></td><td>Response format. Defaults to Prometheus text. One of <code>prometheus</code>, <code>json</code>.</td></tr></tbody></table></figure><p><strong>Responses</strong></p><ul><li><p><code>200</code>: instance metrics</p><ul><li><code>text/plain</code>: <code>string</code></li><li><code>application/json</code>: <code>Metrics</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>version</code></td><td><code>object</code></td><td></td></tr><tr><td><code>database</code></td><td><code>object</code></td><td></td></tr><tr><td><code>noteTypes</code></td><td><code>object</code></td><td>Number of active notes per note type</td></tr><tr><td><code>attachmentTypes</code></td><td><code>object</code></td><td>Number of active attachments per MIME type</td></tr><tr><td><code>statistics</code></td><td><code>object</code></td><td></td></tr><tr><td><code>timestamp</code></td><td><code>string</code></td><td></td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"version\": {\n \"app\": \"0.99.3\",\n \"db\": 231,\n \"node\": \"v22.14.0\",\n \"sync\": 35,\n \"buildDate\": \"2024-09-07T18:36:34Z\",\n \"buildRevision\": \"7c0d6930fa8f20d269dcfbcbc8f636a25f6bb9a7\"\n },\n \"database\": {\n \"totalNotes\": 0,\n \"deletedNotes\": 0,\n \"activeNotes\": 0,\n \"protectedNotes\": 0,\n \"totalAttachments\": 0,\n \"deletedAttachments\": 0,\n \"activeAttachments\": 0,\n \"totalRevisions\": 0,\n \"totalBranches\": 0,\n \"totalAttributes\": 0,\n \"totalBlobs\": 0,\n \"totalEtapiTokens\": 0,\n \"totalRecentNotes\": 0\n },\n \"noteTypes\": {\n \"text\": 800,\n \"code\": 200\n },\n \"attachmentTypes\": {\n \"image/png\": 45,\n \"application/pdf\": 14\n },\n \"statistics\": {\n \"oldestNote\": \"string\",\n \"newestNote\": \"string\",\n \"lastModified\": \"string\",\n \"databaseSizeBytes\": 0\n },\n \"timestamp\": \"2024-12-01T12:00:00.000Z\"\n}</code></pre><ul><li><p><code>default</code>: unexpected error</p><ul><li><code>application/json; charset=utf-8</code>: <code>Error</code></li></ul></li></ul><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><pre><code class=\"language-application-json\">{\n \"status\": 400,\n \"code\": \"NOTE_IS_PROTECTED\",\n \"message\": \"Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI\"\n}</code></pre><h2>Schemas</h2><h3><code>CreateNoteDef</code></h3><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>parentNoteId</code> <br><em>required</em></td><td><code>EntityId</code></td><td>Note ID of the parent note in the tree</td></tr><tr><td><code>title</code> <br><em>required</em></td><td><code>string</code></td><td></td></tr><tr><td><code>type</code> <br><em>required</em></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>book</code>, <code>relationMap</code>, <code>render</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td>this needs to be specified only for note types 'code', 'file', 'image'.</td></tr><tr><td><code>content</code> <br><em>required</em></td><td><code>string</code></td><td></td></tr><tr><td><code>notePosition</code></td><td><code>integer</code></td><td>Position of the note in the parent. Normal ordering is 10, 20, 30 ... So if you want to create a note on the first position, use e.g. 5, for second position 15, for last e.g. 1000000</td></tr><tr><td><code>prefix</code></td><td><code>string</code></td><td>Prefix is branch (placement) specific title prefix for the note. Let's say you have your note placed into two different places in the tree, but you want to change the title a bit in one of the placements. For this you can use prefix.</td></tr><tr><td><code>isExpanded</code></td><td><code>boolean</code></td><td>true if this note (as a folder) should appear expanded</td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>DON'T specify unless you want to force a specific noteId</td></tr><tr><td><code>branchId</code></td><td><code>EntityId</code></td><td>DON'T specify unless you want to force a specific branchId</td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td>Local timestap of the note creation. Specify only if you want to override the default (current datetime in the current timezone/offset).</td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td>UTC timestap of the note creation. Specify only if you want to override the default (current datetime).</td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>UTC timestamp of the note's last modification, e.g. to keep the date of a note being migrated from another application. The local dateModified is derived from it. Specify only if you want to override the default (current datetime).</td></tr></tbody></table></figure><h3><code>Note</code></h3><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the note. Returned as \"[protected]\" for protected notes, since ETAPI cannot open a protected session.</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>attributes</code></td><td><code>AttributeList</code></td><td></td></tr><tr><td><code>parentNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childNoteIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>parentBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>childBranchIds</code></td><td><code>EntityIdList</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td>Writable through PATCH, e.g. to restore a migrated note's date after its content was rewritten. The local dateModified is derived from it.</td></tr></tbody></table></figure><h3><code>Branch</code></h3><p>Branch places the note into the tree, it represents the relationship between a parent note and child note</p><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>branchId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>parentNoteId</code></td><td><code>EntityId</code></td><td>identifies the parent note</td></tr><tr><td><code>prefix</code></td><td><code>string</code></td><td></td></tr><tr><td><code>notePosition</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isExpanded</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><h3><code>NoteWithBranch</code></h3><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>note</code></td><td><code>Note</code></td><td></td></tr><tr><td><code>branch</code></td><td><code>Branch</code></td><td>Branch places the note into the tree, it represents the relationship between a parent note and child note</td></tr></tbody></table></figure><h3><code>Attachment</code></h3><p>Attachment is owned by a note, has title and content</p><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attachmentId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>ownerId</code></td><td><code>EntityId</code></td><td>identifies the owner of the attachment, is either noteId or revisionId</td></tr><tr><td><code>role</code></td><td><code>string</code></td><td></td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title of the attachment. Returned as \"[protected]\" for protected attachments, since ETAPI cannot open a protected session.</td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>dateModified</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateScheduledForErasureSince</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>contentLength</code></td><td><code>integer (int32)</code></td><td></td></tr></tbody></table></figure><h3><code>CreateAttachment</code></h3><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>ownerId</code></td><td><code>EntityId</code></td><td>identifies the owner of the attachment, is either noteId or revisionId</td></tr><tr><td><code>role</code></td><td><code>string</code></td><td></td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td></td></tr><tr><td><code>content</code></td><td><code>string</code></td><td>Text content of the attachment, stored as-is. To store binary content, create the attachment without it, then upload the data with <code>PUT /attachments/{attachmentId}/content</code>.</td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr></tbody></table></figure><h3><code>Attribute</code></h3><p>Attribute (Label, Relation) is a key-value record attached to a note.</p><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>attributeId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td>identifies the child note</td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>label</code>, <code>relation</code>.</td></tr><tr><td><code>name</code></td><td><code>string</code></td><td></td></tr><tr><td><code>value</code></td><td><code>string</code></td><td></td></tr><tr><td><code>position</code></td><td><code>integer (int32)</code></td><td></td></tr><tr><td><code>isInheritable</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr></tbody></table></figure><h3><code>AttributeList</code></h3><p>Type: <code>array of Attribute</code></p><h3><code>SearchResponse</code></h3><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>results</code> <br><em>required</em></td><td><code>array of Note</code></td><td></td></tr><tr><td><code>debugInfo</code></td><td><code>object</code></td><td>debugging info on parsing the search query enabled with &amp;debug=true parameter</td></tr></tbody></table></figure><h3><code>EntityId</code></h3><p>Type: <code>string</code></p><h3><code>StringId</code></h3><p>Type: <code>string</code></p><h3><code>EntityIdList</code></h3><p>Type: <code>array of EntityId</code></p><h3><code>LocalDateTime</code></h3><p>Type: <code>string</code></p><h3><code>UtcDateTime</code></h3><p>Type: <code>string</code></p><h3><code>AppInfo</code></h3><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>appVersion</code></td><td><code>string</code></td><td>Trilium version</td></tr><tr><td><code>dbVersion</code></td><td><code>integer (int32)</code></td><td>DB version</td></tr><tr><td><code>syncVersion</code></td><td><code>integer (int32)</code></td><td>Sync protocol version</td></tr><tr><td><code>buildDate</code></td><td><code>string (date-time)</code></td><td>build date</td></tr><tr><td><code>buildRevision</code></td><td><code>string</code></td><td>git build revision</td></tr><tr><td><code>dataDirectory</code></td><td><code>string</code></td><td>data directory where Trilium stores files</td></tr><tr><td><code>clipperProtocolVersion</code></td><td><code>string</code></td><td>version of the supported Trilium Web Clipper protocol</td></tr><tr><td><code>utcDateTime</code></td><td><code>string</code></td><td>current UTC date time</td></tr></tbody></table></figure><h3><code>Error</code></h3><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code> <br><em>required</em></td><td><code>integer (int32)</code></td><td>HTTP status, identical to the one given in HTTP response</td></tr><tr><td><code>code</code> <br><em>required</em></td><td><code>string</code></td><td>stable string constant</td></tr><tr><td><code>message</code> <br><em>required</em></td><td><code>string</code></td><td>Human readable error, potentially with more details,</td></tr></tbody></table></figure><h3><code>Revision</code></h3><p>Revision represents a snapshot of note's title and content at some point in the past.</p><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>revisionId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>type</code></td><td><code>string</code></td><td>One of <code>text</code>, <code>code</code>, <code>render</code>, <code>file</code>, <code>image</code>, <code>search</code>, <code>relationMap</code>, <code>book</code>, <code>noteMap</code>, <code>mermaid</code>, <code>webView</code>, <code>shortcut</code>, <code>doc</code>, <code>contentWidget</code>, <code>launcher</code>.</td></tr><tr><td><code>mime</code></td><td><code>string</code></td><td></td></tr><tr><td><code>isProtected</code></td><td><code>boolean</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td></td></tr><tr><td><code>blobId</code></td><td><code>string</code></td><td>ID of the blob object which effectively serves as a content hash</td></tr><tr><td><code>dateLastEdited</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>dateCreated</code></td><td><code>LocalDateTime</code></td><td></td></tr><tr><td><code>utcDateLastEdited</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateCreated</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>utcDateModified</code></td><td><code>UtcDateTime</code></td><td></td></tr><tr><td><code>contentLength</code></td><td><code>integer (int32)</code></td><td></td></tr></tbody></table></figure><h3><code>RecentChange</code></h3><p>Represents a recent change event (creation, modification, or deletion).</p><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>noteId</code></td><td><code>EntityId</code></td><td></td></tr><tr><td><code>title</code></td><td><code>string</code></td><td>Title at the time of the change (may be \"[protected]\" for protected notes)</td></tr><tr><td><code>current_title</code></td><td><code>string</code></td><td>Current title of the note (may be \"[protected]\" for protected notes)</td></tr><tr><td><code>current_isDeleted</code></td><td><code>boolean</code></td><td>Whether the note is currently deleted</td></tr><tr><td><code>current_deleteId</code></td><td><code>string</code></td><td>Delete ID if the note is deleted</td></tr><tr><td><code>current_isProtected</code></td><td><code>boolean</code></td><td>Whether the note is protected</td></tr><tr><td><code>utcDate</code></td><td><code>UtcDateTime</code></td><td>UTC timestamp of the change</td></tr><tr><td><code>date</code></td><td><code>LocalDateTime</code></td><td>Local timestamp of the change</td></tr><tr><td><code>canBeUndeleted</code></td><td><code>boolean</code></td><td>Whether the note can be undeleted (only present for deleted notes)</td></tr></tbody></table></figure><h3><code>Metrics</code></h3><p>Instance and database metrics, as served by GET /etapi/metrics?format=json</p><figure class=\"table\"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>version</code></td><td><code>object</code></td><td></td></tr><tr><td><code>database</code></td><td><code>object</code></td><td></td></tr><tr><td><code>noteTypes</code></td><td><code>object</code></td><td>Number of active notes per note type</td></tr><tr><td><code>attachmentTypes</code></td><td><code>object</code></td><td>Number of active attachments per MIME type</td></tr><tr><td><code>statistics</code></td><td><code>object</code></td><td></td></tr><tr><td><code>timestamp</code></td><td><code>string</code></td><td></td></tr></tbody></table></figure>",
"_help_47ZrP6FNuoG8": "<p>When a new note is created, its name is by default \"new note\". In some cases, it can be desirable to have a different or even a dynamic default note title.</p><p>For this use case, Trilium (since v0.52) supports <code>#titleTemplate</code> <a href=\"#root/_help_zEY4DaJG4YT5\">label</a>. You can create such a label for a given note, assign it a value, and this value will be used as a default title when creating child notes. As with other labels, you can make it inheritable to apply recursively, and you can even place it on the root note to have it applied globally everywhere.</p><p>As an example use case, imagine you collect books you've read in a given year like this:</p><ul><li>2022 Books<ul><li>Neal Stephenson: Anathem, 2008</li><li>Franz Kafka: Die Verwandlung, 1915</li></ul></li></ul><p>Now, to the parent note \"2022 Books\" you can assign label <code>#titleTemplate=\"[Author name]: [Book title], [Publication year]\"</code>.</p><p>And all children of \"2022 Books\" will be created with initial title \"[Author name]: [Book title], [Publication year]\". There's no artificial intelligence here, the idea is to just prompt you to manually fill in the pieces of information into the note title by yourself.</p><h2>Titles set by a template</h2><p>A template can name the notes created from it, wherever they are created. To do so, add a <code>#template:titleTemplate</code> label to the template note, for example <code>#template:titleTemplate=\"Meeting ${now.format('YYYY-MM-DD')}\"</code> on a <em>Meeting</em> template.</p><ul><li>It applies both when the template is picked explicitly and when it comes from a parent's <code>~child:template</code>. See <a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>.</li><li>It takes precedence over the parent's <code>#titleTemplate</code>. A title typed in by the user always wins.</li><li>It can be inherited from the template's ancestors in the tree (for example, a folder holding several templates), in which case a label owned by the template itself takes precedence. A note created from a template and later marked as a template does not keep that template's title.</li><li>Its value is evaluated the same way as <code>#titleTemplate</code>, with <code>parentNote</code> being the parent of the new note.</li></ul><h2>Dynamic value</h2><p>The value of <code>#titleTemplate</code> is evaluated at the point of note's creation as a JavaScript string, which means it can be enriched with the help of JS string interpolation with dynamic data.</p><p>Second variable injected is <code>parentNote</code> which gives access to the parent <a href=\"{{helpAssets}}/User%20Guide/Scripting/Script%20API/Frontend%20API/FNote.dat\"><code>FNote</code></a>.</p><p>See also&nbsp;<a class=\"reference-link\" href=\"#root/_help_KC1HB96bqqHX\">Templates</a>&nbsp;which provides similar capabilities, including default note's content.</p><h3>Examples</h3><ul><li>Imagine you collect server outage incidents and write some notes. It looks like this:<ul><li>Incidents<ul><li>2022-05-09: System crash</li><li>2022-05-15: Backup delay</li></ul></li><li>You can automatize the date assignment by assigning a label <code>#titleTemplate=\"${now.format('YYYY-MM-DD')}: \"</code> to the parent note \"Incidents\". Whenever a new child note is created, the title template is evaluated with the injected <a href=\"https://day.js.org/docs/en/display/format\">now</a> object.</li></ul></li><li>To use a parent's attribute in the title of new notes: <code>#titleTemplate=\"${parentNote.getLabelValue('authorName')}'s literary works\"</code></li><li>To mirror the parent's note title: <code>${parentNote.title}</code></li></ul>",
"_help_wX4HbRucYSDD": "<p>Your Trilium data is stored in a <a href=\"https://www.sqlite.org\">SQLite</a> database which contains all notes, tree structure, metadata, and most of the configuration. The database file is named <code>document.db</code> and is stored in the application's default&nbsp;<a href=\"#root/_help_tAassRL4RSQL\">Data directory</a>.</p><h2>Demo Notes</h2><p>When first starting Trilium, it will provide a set of notes to showcase various features of the application.</p><p>For more information see&nbsp;<a class=\"reference-link\" href=\"#root/_help_6tZeKvSHEUiB\">Demo Notes</a>.</p><h2>Manually Modifying the Database</h2><p>Trilium provides a lot of flexibility, and with it, opportunities for advanced users to tweak it. If you need to explore or modify the database directly, you can use a tool such as <a href=\"https://sqlitebrowser.org/\">SQLite Browser</a> to work directly on the database file.</p><p>See&nbsp;<a href=\"#root/_help_oyIAJ9PvvwHX\">Manually altering the database</a>&nbsp;for more information.</p><h2>How to Reset the Database</h2><p>If you want to start again and:</p><ul><li>Create and switch to a new blank knowledge base</li><li>Use a different knowledge base synced from a server or desktop application</li><li>Restore a backup</li></ul><p>You can navigate to&nbsp;<a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Database</em> and click the <em>Start over</em> button. You'll be prompted to restart the application, with the option to back up your current database before proceeding.</p><aside class=\"admonition important\"><p>For the web client, Trilium cannot restart automatically. You'll need to manually restart the server/container and then reload the web application.</p></aside><p>After restarting, the setup screen will appear. You can choose to back up your existing database, then proceed with the setup menu as if it's a new installation. The existing database will only be overwritten after selecting to create a new database, sync with a server, or restore from a backup.</p><h3>The Legacy Method</h3><p>If you are experimenting with Trilium and want to return it to its original state, you can do that by deleting the current database. When you restart the application, it will generate a new database containing the original demo notes.</p><p>To delete the database, simply go to the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a> and delete the <code>document.db</code> file (and any other files starting with <code>document.db</code>).</p><p>If you do not need to preserve any configurations that might be stored in the <code>config.ini</code> file, you can just delete all of the <a href=\"#root/_help_tAassRL4RSQL\">data directory's</a> contents to fully restore the application to its original state. You can also review the <a href=\"#root/_help_Gzjqa934BdH4\">configuration</a> file to provide all <code>config.ini</code> values as environment variables instead.</p>",
"_help_oyIAJ9PvvwHX": "<p>There are some situations where modifying the SQLite database that Trilium uses is desirable.</p><p>If you are doing any advanced development or troubleshooting where you manually modify the database, you might want to consider creating backups of your <code>document.db</code> file.</p><h2>Modifying it internally using the SQL Console</h2><p>The SQL Console is Trilium's built-in database editor.</p><p>See&nbsp;<a class=\"reference-link\" href=\"#root/_help_YKWqdJhzi2VY\">SQL Console</a>.</p><h2>Externally modifying the database</h2><p>Sometimes the SQL Console cannot be used (for example if the application cannot start).</p><p>When making external modifications, consider closing the desktop application. If modifying the server database, then stop the service or Docker container.</p><h3>Using DB Browser for SQLite</h3><p>DB Browser for SQLite is a cross-platform editor that can be used to alter the database using a graphical user interface.</p><p>To do so:</p><ol><li>In the main menu, select File → Open database… and navigate to the database in the&nbsp;<a href=\"#root/_help_tAassRL4RSQL\">Data directory</a>.</li><li>Select the <em>Execute SQL</em> tab.</li><li>Type in the desired SQL statement.</li><li>Press the \"Play\" button in the toolbar underneath the \"Execute SQL\" tab (or F5 key).</li><li>Press \"Write Changes\" in the main toolbar.</li><li>Close the application or close the database.</li></ol><p><img src=\"{{helpAssets}}/User%20Guide/Advanced%20Usage/Database/Manually%20altering%20the%20database_image.jpg\"></p><h3>Using the SQLite CLI</h3><p>First, start the SQLite 3 CLI by specifying the path to the database:</p><pre><code class=\"language-text-x-trilium-auto\">sqlite3 ~/.local/share/trilium-data/document.db</code></pre><ul><li>In the prompt simply type the statement and make sure it ends with a <code>;</code> character.</li><li>To exit, simply type <code>.quit</code> and enter.</li></ul>",
diff --git a/docs/User Guide/User Guide/Advanced Usage/ETAPI (REST API)/API Reference.md b/docs/User Guide/User Guide/Advanced Usage/ETAPI (REST API)/API Reference.md
index 8bc1763590..571e9e1a93 100644
--- a/docs/User Guide/User Guide/Advanced Usage/ETAPI (REST API)/API Reference.md
+++ b/docs/User Guide/User Guide/Advanced Usage/ETAPI (REST API)/API Reference.md
@@ -15,7 +15,9 @@ Basic Auth where username is arbitrary string (e.g. "trilium", not checked), use
## Endpoints
-### `POST /create-note`
+### `createNote`
+
+`POST /create-note`
Create a note and place it into the note tree
@@ -138,7 +140,9 @@ Create a note and place it into the note tree
}
```
-### `GET /notes`
+### `searchNotes`
+
+`GET /notes`
Search notes
@@ -231,7 +235,9 @@ Search notes
}
```
-### `GET /notes/{noteId}`
+### `getNoteById`
+
+`GET /notes/{noteId}`
Returns a note identified by its ID
@@ -324,7 +330,9 @@ Returns a note identified by its ID
}
```
-### `DELETE /notes/{noteId}`
+### `deleteNoteById`
+
+`DELETE /notes/{noteId}`
deletes a single note based on the noteId supplied
@@ -357,7 +365,9 @@ deletes a single note based on the noteId supplied
}
```
-### `PATCH /notes/{noteId}`
+### `patchNoteById`
+
+`PATCH /notes/{noteId}`
patch a note identified by the noteId with changes in the body
@@ -484,7 +494,9 @@ patch a note identified by the noteId with changes in the body
}
```
-### `GET /notes/{noteId}/content`
+### `getNoteContent`
+
+`GET /notes/{noteId}/content`
Returns note content identified by its ID
@@ -502,7 +514,9 @@ Returns note content identified by its ID
* `*/*`: `string (binary)`
-### `PUT /notes/{noteId}/content`
+### `putNoteContentById`
+
+`PUT /notes/{noteId}/content`
Updates note content identified by its ID
@@ -525,7 +539,9 @@ New content of the note. Send text (such as the HTML of a text note) as `text/pl
* `204`: note content updated
-### `GET /notes/{noteId}/export`
+### `exportNoteSubtree`
+
+`GET /notes/{noteId}/export`
Exports ZIP file export of a given note subtree. To export whole document, use "root" for noteId
@@ -561,7 +577,9 @@ Exports ZIP file export of a given note subtree. To export whole document, use "
}
```
-### `POST /notes/{noteId}/import`
+### `importZip`
+
+`POST /notes/{noteId}/import`
Imports ZIP file into a given note.
@@ -652,7 +670,9 @@ Imports ZIP file into a given note.
}
```
-### `POST /notes/{noteId}/revision`
+### `createRevision`
+
+`POST /notes/{noteId}/revision`
Create a note revision for the given note
@@ -686,7 +706,9 @@ Create a note revision for the given note
}
```
-### `GET /notes/{noteId}/revisions`
+### `getNoteRevisions`
+
+`GET /notes/{noteId}/revisions`
Returns the revisions of a note identified by its ID. Protected revisions are omitted, since they cannot be read through ETAPI individually either.
@@ -742,7 +764,9 @@ Returns the revisions of a note identified by its ID. Protected revisions are om
}
```
-### `GET /notes/{noteId}/attachments`
+### `getNoteAttachments`
+
+`GET /notes/{noteId}/attachments`
Returns all attachments for a note identified by its ID
@@ -796,7 +820,9 @@ Returns all attachments for a note identified by its ID
}
```
-### `POST /notes/{noteId}/undelete`
+### `undeleteNote`
+
+`POST /notes/{noteId}/undelete`
Restore a deleted note. The note must be deleted and must have at least one undeleted parent.
@@ -842,7 +868,9 @@ Restore a deleted note. The note must be deleted and must have at least one unde
}
```
-### `GET /notes/history`
+### `getNoteHistory`
+
+`GET /notes/history`
Returns recent changes including note creations, modifications, and deletions
@@ -894,7 +922,9 @@ Returns recent changes including note creations, modifications, and deletions
}
```
-### `GET /revisions/{revisionId}`
+### `getRevisionById`
+
+`GET /revisions/{revisionId}`
Returns a revision identified by its ID
@@ -964,7 +994,9 @@ Returns a revision identified by its ID
}
```
-### `GET /revisions/{revisionId}/content`
+### `getRevisionContent`
+
+`GET /revisions/{revisionId}/content`
Returns revision content identified by its ID
@@ -999,7 +1031,9 @@ Returns revision content identified by its ID
}
```
-### `POST /branches`
+### `postBranch`
+
+`POST /branches`
Create a branch (clone a note to a different location in the tree). In case there is a branch between parent note and child note already, then this will update the existing branch with prefix, notePosition and isExpanded.
@@ -1100,7 +1134,9 @@ Create a branch (clone a note to a different location in the tree). In case ther
}
```
-### `GET /branches/{branchId}`
+### `getBranchById`
+
+`GET /branches/{branchId}`
Returns a branch identified by its ID
@@ -1158,7 +1194,9 @@ Returns a branch identified by its ID
}
```
-### `DELETE /branches/{branchId}`
+### `deleteBranchById`
+
+`DELETE /branches/{branchId}`
deletes a branch based on the branchId supplied. If this is the last branch of the (child) note, then the note is deleted as well.
@@ -1191,7 +1229,9 @@ deletes a branch based on the branchId supplied. If this is the last branch of t
}
```
-### `PATCH /branches/{branchId}`
+### `patchBranchById`
+
+`PATCH /branches/{branchId}`
patch a branch identified by the branchId with changes in the body. Only prefix and notePosition can be updated. If you want to update other properties, you need to delete the old branch and create a new one.
@@ -1272,7 +1312,9 @@ patch a branch identified by the branchId with changes in the body. Only prefix
}
```
-### `POST /attachments`
+### `postAttachment`
+
+`POST /attachments`
create an attachment
@@ -1356,7 +1398,9 @@ create an attachment
}
```
-### `GET /attachments/{attachmentId}`
+### `getAttachmentById`
+
+`GET /attachments/{attachmentId}`
Returns an attachment identified by its ID
@@ -1422,7 +1466,9 @@ Returns an attachment identified by its ID
}
```
-### `DELETE /attachments/{attachmentId}`
+### `deleteAttachmentById`
+
+`DELETE /attachments/{attachmentId}`
deletes an attachment based on the attachmentId supplied.
@@ -1455,7 +1501,9 @@ deletes an attachment based on the attachmentId supplied.
}
```
-### `PATCH /attachments/{attachmentId}`
+### `patchAttachmentById`
+
+`PATCH /attachments/{attachmentId}`
patch an attachment identified by the attachmentId with changes in the body. Only role, mime, title, and position are patchable.
@@ -1551,7 +1599,9 @@ patch an attachment identified by the attachmentId with changes in the body. Onl
}
```
-### `GET /attachments/{attachmentId}/content`
+### `getAttachmentContent`
+
+`GET /attachments/{attachmentId}/content`
Returns attachment content identified by its ID
@@ -1569,7 +1619,9 @@ Returns attachment content identified by its ID
* `*/*`: `string (binary)`
-### `PUT /attachments/{attachmentId}/content`
+### `putAttachmentContentById`
+
+`PUT /attachments/{attachmentId}/content`
Updates attachment content identified by its ID
@@ -1592,7 +1644,9 @@ New content of the attachment. Send text as `text/plain` and binary data (such a
* `204`: attachment content updated
-### `POST /attributes`
+### `postAttribute`
+
+`POST /attributes`
create an attribute for a given note
@@ -1672,7 +1726,9 @@ create an attribute for a given note
}
```
-### `GET /attributes/{attributeId}`
+### `getAttributeById`
+
+`GET /attributes/{attributeId}`
Returns an attribute identified by its ID
@@ -1732,7 +1788,9 @@ Returns an attribute identified by its ID
}
```
-### `DELETE /attributes/{attributeId}`
+### `deleteAttributeById`
+
+`DELETE /attributes/{attributeId}`
deletes an attribute based on the attributeId supplied.
@@ -1765,7 +1823,9 @@ deletes an attribute based on the attributeId supplied.
}
```
-### `PATCH /attributes/{attributeId}`
+### `patchAttributeById`
+
+`PATCH /attributes/{attributeId}`
patch an attribute identified by the attributeId with changes in the body. For labels, only value and position can be updated. For relations, only position can be updated. If you want to modify other properties, you need to delete the old attribute and create a new one.
@@ -1851,7 +1911,9 @@ patch an attribute identified by the attributeId with changes in the body. For l
}
```
-### `POST /refresh-note-ordering/{parentNoteId}`
+### `postRefreshNoteOrdering`
+
+`POST /refresh-note-ordering/{parentNoteId}`
notePositions in branches are not automatically pushed to connected clients and need a specific instruction. If you want your changes to be in effect immediately, call this service after setting branches' notePosition. Note that you need to supply "parentNoteId" of branch(es) with changed positions.
@@ -1884,7 +1946,9 @@ notePositions in branches are not automatically pushed to connected clients and
}
```
-### `GET /inbox/{date}`
+### `getInboxNote`
+
+`GET /inbox/{date}`
returns an "inbox" note, into which note can be created. Date will be used depending on whether the inbox is a fixed note (identified with #inbox label) or a day note in a journal. A database with neither returns the root note, and ignores the date, rather than creating a journal to hold a day note.
@@ -1977,7 +2041,9 @@ returns an "inbox" note, into which note can be created. Date will be used depen
}
```
-### `GET /calendar/days/{date}`
+### `getDayNote`
+
+`GET /calendar/days/{date}`
returns a day note for a given date. Gets created if doesn't exist.
@@ -2070,9 +2136,9 @@ returns a day note for a given date. Gets created if doesn't exist.
}
```
-### `GET /calendar/week-first-day/{date}`
+### Get the day note starting the week
-Get the day note starting the week
+`GET /calendar/week-first-day/{date}`
Returns the day note for the first day of the week containing the given date, honouring the configured first day of week. The note is created if it doesn't exist. This returns a day note, not a week note, so unlike /calendar/weeks/{week} it does not require the enableWeekNote label on the calendar root.
@@ -2165,9 +2231,9 @@ Returns the day note for the first day of the week containing the given date, ho
}
```
-### `GET /calendar/weeks/{week}`
+### Get a week note
-Get a week note
+`GET /calendar/weeks/{week}`
Returns a week note for a given ISO week (format YYYY-Www, e.g., 2025-W01). The note is created if it doesn't exist.
@@ -2260,9 +2326,9 @@ Returns a week note for a given ISO week (format YYYY-Www, e.g., 2025-W01). The
}
```
-### `GET /calendar/months/{month}`
+### Get a month note
-Get a month note
+`GET /calendar/months/{month}`
Returns a month note for a given month (format YYYY-MM, e.g., 2022-02). The note is created if it doesn't exist.
@@ -2355,9 +2421,9 @@ Returns a month note for a given month (format YYYY-MM, e.g., 2022-02). The note
}
```
-### `GET /calendar/years/{year}`
+### Get a year note
-Get a year note
+`GET /calendar/years/{year}`
Returns a year note for a given year (format YYYY, e.g., 2022). The note is created if it doesn't exist.
@@ -2450,7 +2516,9 @@ Returns a year note for a given year (format YYYY, e.g., 2022). The note is crea
}
```
-### `POST /auth/login`
+### `login`
+
+`POST /auth/login`
get an ETAPI token based on password for further use with ETAPI
@@ -2505,7 +2573,9 @@ get an ETAPI token based on password for further use with ETAPI
}
```
-### `POST /auth/logout`
+### `logout`
+
+`POST /auth/logout`
logout (delete/deactivate) an ETAPI token
@@ -2532,7 +2602,9 @@ logout (delete/deactivate) an ETAPI token
}
```
-### `GET /app-info`
+### `getAppInfo`
+
+`GET /app-info`
returns information about the running Trilium instance
@@ -2586,7 +2658,9 @@ returns information about the running Trilium instance
}
```
-### `PUT /backup/{backupName}`
+### `createBackup`
+
+`PUT /backup/{backupName}`
Create a database backup under a given name
@@ -2619,9 +2693,9 @@ Create a database backup under a given name
}
```
-### `GET /metrics`
+### Get instance metrics
-Get instance metrics
+`GET /metrics`
Returns instance and database metrics for monitoring: note, attachment, revision, branch, attribute and blob counts, note and attachment type breakdowns, version information and database size. Counts only — no note titles, content or attributes.