((META (EMPTY-STRING title "API: Query the list of all zettel") (WORD role "manual") (TAG-SET tags ("#api" "#manual" "#zettelstore")) (WORD syntax "zmk") (ZID-SET back ("00001012000000")) (ZID-SET backward ("00001007031140" "00001012000000" "00001012051200" "00001012080500" "00001012920000")) (NUMBER box-number "1") (STRING copyright "(c) 2020-present by Detlef Stern <ds@zettelstore.de>") (TIMESTAMP created "20220912111111") (ZID-SET forward ("00001006020000" "00001006034000" "00001006035500" "00001007031140" "00001007700000" "00001010040100" "00001012050200" "00001012080500" "00001012920000" "00001012921200" "00001012930500" "00001014000000")) (WORD lang "en") (EMPTY-STRING license "EUPL-1.2-or-later") (TIMESTAMP modified "20240711161320") (ZID-SET precursor ("00001012051200")) (TIMESTAMP published "20240711161320") (WORD visibility "public")) (BLOCK (PARA (TEXT "The ") (LINK-ZETTEL () "00001012920000" (TEXT "endpoint")) (TEXT " ") (LITERAL-INPUT () "/z") (TEXT " also allows you to filter the list of all zettel") (ENDNOTE () (TEXT "If ") (LINK-ZETTEL () "00001010040100" (TEXT "authentication is enabled")) (TEXT ", you must include the a valid ") (LINK-ZETTEL () "00001012050200" (TEXT "access token")) (TEXT " in the ") (LITERAL-INPUT () "Authorization") (TEXT " header")) (TEXT " and optionally to provide some actions.")) (PARA (TEXT "A ") (LINK-ZETTEL () "00001007700000" (TEXT "query")) (TEXT " is an optional ") (LINK-ZETTEL () "00001007700000#search-expression" (TEXT "search expression")) (TEXT ", together with an optional ") (LINK-ZETTEL () "00001007700000#action-list" (TEXT "list of actions")) (TEXT " (described below).") (SOFT) (TEXT "An empty search expression will select all zettel.") (SOFT) (TEXT "An empty list of action, or no valid action, returns the list of all selected zettel metadata.")) (PARA (TEXT "Search expression and action list are separated by a vertical bar character (") (FORMAT-QUOTE () (LITERAL-INPUT () "|")) (TEXT ", U+007C), and must be given with the query parameter ") (LITERAL-INPUT () "q") (TEXT ".")) (PARA (TEXT "The query parameter ") (FORMAT-QUOTE () (LITERAL-INPUT () "q")) (TEXT " allows you to specify ") (LINK-ZETTEL () "00001007700000" (TEXT "query expressions")) (TEXT " for a full-text search of all zettel content and/or restricting the search according to specific metadata.")) (PARA (TEXT "It is allowed to specify this query parameter more than once.")) (PARA (TEXT "This parameter loosely resembles the search form of the ") (LINK-ZETTEL () "00001014000000" (TEXT "web user interface")) (TEXT " or those of ") (LINK-ZETTEL () "00001007031140" (TEXT "Zettelmarkup's Query Transclusion")) (TEXT ".")) (PARA (TEXT "For example, if you want to retrieve all zettel that contain the string ") (FORMAT-QUOTE () (TEXT "API")) (TEXT " in its title, your request will be:")) (VERBATIM-CODE (("" . "sh")) "# curl 'http://127.0.0.1:23123/z?q=title%3AAPI+ORDER+REVERSE+id+OFFSET+1'\n00001012921000 API: Structure of an access token\n00001012920500 Formats available by the API\n00001012920000 Endpoints used by the API\n...") (PARA (TEXT "If you want to retrieve a data document, as a ") (LINK-ZETTEL () "00001012930500" (TEXT "symbolic expression")) (TEXT ":")) (VERBATIM-CODE (("" . "sh")) "# curl 'http://127.0.0.1:23123/z?q=title%3AAPI+ORDER+REVERSE+id+OFFSET+1&enc=data'\n(meta-list (query \"title:API ORDER REVERSE id OFFSET 1\") (human \"title HAS API ORDER REVERSE id OFFSET 1\") (list (zettel (id 1012921000) (meta (title \"API: Structure of an access token\") (role \"manual\") (tags \"#api #manual #reference #zettelstore\") (syntax \"zmk\") (back \"00001012050600 00001012051200\") (backward \"00001012050200 00001012050400 00001012050600 00001012051200\") (box-number \"1\") (created \"20210126175322\") (forward \"00001012050200 00001012050400 00001012930000\") (modified \"20230412155303\") (published \"20230412155303\")) (rights 62)) (zettel (id 1012920500) (meta (title \"Encodings available via the API\") (role \"manual\") (tags \"#api #manual #reference #zettelstore\") (syntax \"zmk\") (back \"00001006000000 00001008010000 00001008010500 00001012053500 00001012053600\") (backward \"00001006000000 00001008010000 00001008010500 00001012053500 00001012053600\") (box-number \"1\") (created \"20210126175322\") (forward \"00001012000000 00001012920510 00001012920513 00001012920516 00001012920519 00001012920522 00001012920525\") (modified \"20230403123653\") (published \"20230403123653\")) (rights 62)) (zettel (id 1012920000) (meta (title \"Endpoints used by the API\") ...") (PARA (TEXT "The data object contains a key ") (LITERAL-INPUT () "\"meta-list\"") (TEXT " to signal that it contains a list of metadata values (and some more).") (SOFT) (TEXT "It contains the keys ") (LITERAL-INPUT () "\"query\"") (TEXT " and ") (LITERAL-INPUT () "\"human\"") (TEXT " with a string value.") (SOFT) (TEXT "Both will contain a textual description of the underlying query if you select only some zettel with a ") (LINK-ZETTEL () "00001007700000" (TEXT "query expression")) (TEXT ".") (SOFT) (TEXT "Without a selection, the values are the empty string.") (SOFT) (LITERAL-INPUT () "\"query\"") (TEXT " returns the normalized query expression itself, while ") (LITERAL-INPUT () "\"human\"") (TEXT " is the normalized query expression to be read by humans.")) (PARA (TEXT "The symbol ") (LITERAL-INPUT () "list") (TEXT " starts the list of zettel data.") (SOFT) (TEXT "Data of a zettel is indicated by the symbol ") (LITERAL-INPUT () "zettel") (TEXT ", followed by ") (LITERAL-INPUT () "(id ID)") (TEXT " that describes the zettel identifier as a numeric value.") (SOFT) (TEXT "Leading zeroes are removed.") (SOFT) (TEXT "Metadata starts with the symbol ") (LITERAL-INPUT () "meta") (TEXT ", and each metadatum itself is a list of metadata key / metadata value.") (SOFT) (TEXT "Metadata keys are encoded as a symbol, metadata values as a string.") (SOFT) (LITERAL-INPUT () "\"rights\"") (TEXT " encodes the ") (LINK-ZETTEL () "00001012921200" (TEXT "access rights")) (TEXT " for the given zettel.")) (HEADING 1 () "aggregates" "aggregates" (TEXT "Aggregates")) (PARA (TEXT "An implicit precondition is that the zettel must contain the given metadata key.") (SOFT) (TEXT "For a metadata key like ") (LINK-ZETTEL () "00001006020000#title" (LITERAL-INPUT () "title")) (TEXT ", which have a default value, this precondition should always be true.") (SOFT) (TEXT "But the situation is different for a key like ") (LINK-ZETTEL () "00001006020000#url" (LITERAL-INPUT () "url")) (TEXT ".") (SOFT) (TEXT "Both ") (LITERAL-CODE () "curl 'http://localhost:23123/z?q=url%3A'") (TEXT " and ") (LITERAL-CODE () "curl 'http://localhost:23123/z?q=url%3A!'") (TEXT " may result in an empty list.")) (PARA (TEXT "As an example for a query action, to list all roles used in the Zettelstore, send a HTTP GET request to the endpoint ") (LITERAL-INPUT () "/z?q=|role") (TEXT ".")) (VERBATIM-CODE (("" . "sh")) "# curl 'http://127.0.0.1:23123/z?q=|role'\nconfiguration\t00001000000100 00000000090002 00000000090000 00000000040001 00000000025001 00000000020001 00000000000100 00000000000092 00000000000090 00000000000006 00000000000005 00000000000004 00000000000001\nmanual\t00001018000000 00001017000000 00001014000000 00001012921200 00001012921000 00001012920800 00001012920588 00001012920584 00001012920582 00001012920522 00001012920519 00001012920516 00001012920513 00001012920510 00001012920503 00001012920500 00001012920000 00001012080500 00001012080200 00001012080100 00001012070500 00001012054600 00001012054400 00001012054200 00001012054000 00001012053900 00001012053800 00001012053600 00001012053500 00001012053400 00001012053300 00001012053200 00001012051400 00001012051200 00001012050600 00001012050400 00001012050200 00001012000000 00001010090100 00001010070600 00001010070400 00001010070300 00001010070200 00001010040700 00001010040400 00001010040200 00001010040100 00001010000000 00001008050000 00001008010500 00001008010000 00001008000000 00001007990000 00001007906000 00001007903000 00001007900000 00001007800000 00001007790000 00001007780000 00001007706000 00001007705000 00001007702000 00001007700000 00001007050200 00001007050100 00001007050000 00001007040350 00001007040340 00001007040330 00001007040324 00001007040322 00001007040320 00001007040310 00001007040300 00001007040200 00001007040100 00001007040000 00001007031400 00001007031300 00001007031200 00001007031140 00001007031110 00001007031100 00001007031000 00001007030900 00001007030800 00001007030700 00001007030600 00001007030500 00001007030400 00001007030300 00001007030200 00001007030100 00001007030000 00001007020000 00001007010000 00001007000000 00001006055000 00001006050000 00001006036500 00001006036000 00001006035500 00001006035000 00001006034500 00001006034000 00001006033500 00001006033000 00001006032500 00001006032000 00001006031500 00001006031000 00001006030500 00001006030000 00001006020400 00001006020100 00001006020000 00001006010000 00001006000000 00001005090000 00001005000000 00001004101000 00001004100000 00001004059900 00001004059700 00001004051400 00001004051200 00001004051100 00001004051000 00001004050400 00001004050200 00001004050000 00001004020200 00001004020000 00001004011600 00001004011400 00001004011200 00001004010000 00001004000000 00001003600000 00001003315000 00001003310000 00001003305000 00001003300000 00001003000000 00001002000000 00001001000000 00001000000000\nzettel\t00010000000000 00000000090001") (PARA (TEXT "The result is a text file.") (SOFT) (TEXT "The first word, separated by a horizontal tab (U+0009) contains the role name.") (SOFT) (TEXT "The rest of the line consists of zettel identifier, where the corresponding zettel have this role.") (SOFT) (TEXT "Zettel identifier are separated by a space character (U+0020).")) (PARA (TEXT "Please note that the list is ") (FORMAT-STRONG () (TEXT "not")) (TEXT " sorted by the role name, so the same request might result in a different order.") (SOFT) (TEXT "If you want a sorted list, you could sort it on the command line (") (LITERAL-CODE () "curl 'http://127.0.0.1:23123/z?q=|role' | sort") (TEXT ") or within the software that made the call to the Zettelstore.")) (PARA (TEXT "Of course, this list can also be returned as a data object:")) (VERBATIM-CODE (("" . "sh")) "# curl 'http://127.0.0.1:23123/z?q=|role&enc=data'\n(aggregate \"role\" (query \"| role\") (human \"| role\") (list (\"zettel\" 10000000000 90001) (\"configuration\" 6 100 1000000100 20001 90 25001 92 4 40001 1 90000 5 90002) (\"manual\" 1008050000 1007031110 1008000000 1012920513 1005000000 1012931800 1010040700 1012931000 1012053600 1006050000 1012050200 1012000000 1012070500 1012920522 1006032500 1006020100 1007906000 1007030300 1012051400 1007040350 1007040324 1007706000 1012931900 1006030500 1004050200 1012054400 1007700000 1004050000 1006020000 1007030400 1012080100 1012920510 1007790000 1010070400 1005090000 1004011400 1006033000 1012930500 1001000000 1007010000 1006020400 1007040300 1010070300 1008010000 1003305000 1006030000 1006034000 1012054200 1012080200 1004010000 1003300000 1006032000 1003310000 1004059700 1007031000 1003600000 1004000000 1007030700 1007000000 1006055000 1007050200 1006036000 1012050600 1006000000 1012053900 1012920500 1004050400 1007031100 1007040340 1007020000 1017000000 1012053200 1007030600 1007040320 1003315000 1012054000 1014000000 1007030800 1010000000 1007903000 1010070200 1004051200 1007040330 1004051100 1004051000 1007050100 1012080500 1012053400 1006035500 1012054600 1004100000 1010040200 1012920000 1012920525 1004051400 1006031500 1012921200 1008010500 1012921000 1018000000 1012051200 1010040100 1012931200 1012920516 1007040310 1007780000 1007030200 1004101000 1012920800 1007030100 1007040200 1012053500 1007040000 1007040322 1007031300 1007031140 1012931600 1012931400 1004059900 1003000000 1006036500 1004020200 1010040400 1006033500 1000000000 1012053300 1007990000 1010090100 1007900000 1007030500 1004011600 1012930000 1007030900 1004020000 1007030000 1010070600 1007040100 1007800000 1012050400 1006010000 1007705000 1007702000 1007050000 1002000000 1007031200 1006035000 1006031000 1006034500 1004011200 1007031400 1012920519)))") (PARA (TEXT "The data object starts with the symbol ") (LITERAL-INPUT () "aggregate") (TEXT " to signal a different format compared to ") (LITERAL-INPUT () "meta-list") (TEXT " above.") (SOFT) (TEXT "Then a string follows, which specifies the key on which the aggregate was performed.") (SOFT) (LITERAL-INPUT () "query") (TEXT " and ") (LITERAL-INPUT () "human") (TEXT " have the same meaning as above.") (SOFT) (TEXT "The ") (LITERAL-INPUT () "symbol") (TEXT " list starts the result list of aggregates.") (SOFT) (TEXT "Each aggregate starts with a string of the aggregate value, in this case the role value, followed by a list of zettel identifier, denoting zettel which have the given role value.")) (PARA (TEXT "Similar, to list all tags used in the Zettelstore, send a HTTP GET request to the endpoint ") (LITERAL-INPUT () "/z?q=|tags") (TEXT ".") (SOFT) (TEXT "If successful, the output is a data object:")) (VERBATIM-CODE (("" . "sh")) "# curl 'http://127.0.0.1:23123/z?q=|tags&enc=data'\n(aggregate \"tags\" (query \"| tags\") (human \"| tags\") (list (\"#zettel\" 1006034500 1006034000 1006031000 1006020400 1006033500 1006036500 1006032500 1006020100 1006031500 1006030500 1006035500 1006033000 1006020000 1006036000 1006030000 1006032000 1006035000) (\"#reference\" 1006034500 1006034000 1007800000 1012920500 1006031000 1012931000 1006020400 1012930000 1006033500 1012920513 1007050100 1012920800 1007780000 1012921000 1012920510 1007990000 1006036500 1006032500 1006020100 1012931400 1012931800 1012920516 1012931600 1012920525 1012931200 1006031500 1012931900 1012920000 1005090000 1012920522 1006030500 1007050200 1012921200 1006035500 1012920519 1006033000 1006020000 1006036000 1006030000 1006032000 1012930500 1006035000) (\"#graphic\" 1008050000) (\"#search\" 1007700000 1007705000 1007790000 1007780000 1007702000 1007706000 1007031140) (\"#installation\" 1003315000 1003310000 1003000000 1003305000 1003300000 1003600000) (\"#zettelmarkup\" 1007900000 1007030700 1007031300 1007030600 1007800000 1007000000 1007031400 1007040100 1007030300 1007031200 1007040350 1007030400 1007030900 1007050100 1007040000 1007030500 1007903000 1007040200 1007040330 1007990000 1007040320 1007050000 1007040310 1007031100 1007040340 1007020000 1007031110 1007031140 1007040324 1007030800 1007031000 1007030000 1007010000 1007906000 1007050200 1007030100 1007030200 1007040300 1007040322) (\"#design\" 1005000000 1006000000 1002000000 1006050000 1006055000) (\"#markdown\" 1008010000 1008010500) (\"#goal\" 1002000000) (\"#syntax\" 1006010000) ...") (PARA (TEXT "If you want only those tags that occur at least 100 times, use the endpoint ") (LITERAL-INPUT () "/z?q=|MIN100+tags") (TEXT ".") (SOFT) (TEXT "You see from this that actions are separated by space characters.")) (HEADING 1 () "actions" "actions" (TEXT "Actions")) (PARA (TEXT "There are two types of actions: parameters and aggregates.") (SOFT) (TEXT "The following actions are supported:")) (DESCRIPTION ((LITERAL-INPUT () "MINn") (TEXT " (parameter)")) (BLOCK (BLOCK (PARA (TEXT "Emit only those values with at least ") (FORMAT-EMPH () (TEXT "n")) (TEXT " aggregated values.") (SOFT) (FORMAT-EMPH () (TEXT "n")) (TEXT " must be a positive integer, ") (LITERAL-INPUT () "MIN") (TEXT " must be given in upper-case letters.")))) ((LITERAL-INPUT () "MAXn") (TEXT " (parameter)")) (BLOCK (BLOCK (PARA (TEXT "Emit only those values with at most ") (FORMAT-EMPH () (TEXT "n")) (TEXT " aggregated values.") (SOFT) (FORMAT-EMPH () (TEXT "n")) (TEXT " must be a positive integer, ") (LITERAL-INPUT () "MAX") (TEXT " must be given in upper-case letters.")))) ((LITERAL-INPUT () "KEYS") (TEXT " (aggregate)")) (BLOCK (BLOCK (PARA (TEXT "Emit a list of all metadata keys, together with the number of zettel having the key.")))) ((LITERAL-INPUT () "REDIRECT") (TEXT " (aggregate)")) (BLOCK (BLOCK (PARA (TEXT "Performs a HTTP redirect to the first selected zettel, using HTTP status code 302.") (SOFT) (TEXT "The zettel identifier is in the body.")))) ((LITERAL-INPUT () "REINDEX") (TEXT " (aggregate)")) (BLOCK (BLOCK (PARA (TEXT "Updates the internal search index for the selected zettel, roughly similar to the ") (LINK-ZETTEL () "00001012080500" (TEXT "refresh")) (TEXT " API call.") (SOFT) (TEXT "It is not really an aggregate, since it is used only for its side effect.") (SOFT) (TEXT "It is allowed to specify another aggregate.")))) ((TEXT "Any ") (LINK-ZETTEL () "00001006020000" (TEXT "metadata key")) (TEXT " of type ") (LINK-ZETTEL () "00001006035500" (TEXT "Word")) (TEXT " or ") (LINK-ZETTEL () "00001006034000" (TEXT "TagSet")) (TEXT " (aggregates)")) (BLOCK (BLOCK (PARA (TEXT "Emit an aggregate of the given metadata key.") (SOFT) (TEXT "The key can be given in any letter case."))))) (PARA (TEXT "First, ") (LITERAL-INPUT () "REINDEX") (TEXT " actions are executed, then ") (LITERAL-INPUT () "REDIRECT") (TEXT ".") (SOFT) (TEXT "If no ") (LITERAL-INPUT () "REDIRECT") (TEXT " was found the first other aggregate action will be executed.")) (PARA (TEXT "To allow some kind of backward compatibility, an action written in uppercase letters that leads to an empty result list, will be ignored.") (SOFT) (TEXT "In this case the list of selected zettel is returned.")) (HEADING 1 () "http-status-codes" "http-status-codes" (TEXT "HTTP Status codes")) (DESCRIPTION ((LITERAL-INPUT () "200")) (BLOCK (BLOCK (PARA (TEXT "Query was successful.")))) ((LITERAL-INPUT () "204")) (BLOCK (BLOCK (PARA (TEXT "Query was successful, but results in no content.") (SOFT) (TEXT "Most likely, you specified no appropriate aggregator.")))) ((LITERAL-INPUT () "302")) (BLOCK (BLOCK (PARA (TEXT "Query was successful, redirect to first zettel in list.")))) ((LITERAL-INPUT () "400")) (BLOCK (BLOCK (PARA (TEXT "Request was not valid.") (HARD) (TEXT "There are several reasons for this.") (SOFT) (TEXT "Maybe the access bearer token was not valid, or you forgot to specify a valid query.")))))))