/dataview
v0.14+
These routes allow for running Dataview DQL queries. Their URLs start with obsidian://actions-uri/dataview
.
Currently, only LIST
and TABLE
DQL queries are supported.
Root, i.e. /dataview
Does nothing but say hello.
Parameters
Only supports the base parameters (see section “Parameters required in/ accepted by all calls”).
Return values
These parameters will be added to the callbacks used for getting data back from Actions URI.
On success:
Parameter | Description |
---|---|
result-message | A short summary of what was done. |
/dataview/list-query
Parameters
In addition to the base parameters (see section “Parameters required in/ accepted by all calls”):
Parameter | Value type | Optional? | Description |
---|---|---|---|
dql | string | A DQL LIST query. |
Return values
These parameters will be added to the callbacks used for getting data back from Actions URI.
On success:
Parameter | Description |
---|---|
result-data | An array containing strings (the list results), encoded as JSON string. |
On failure:
Parameter | Description |
---|---|
errorCode | A HTTP status code. |
errorMessage | A short summary of what went wrong. |
/dataview/table-query
Parameters
In addition to the base parameters (see section “Parameters required in/ accepted by all calls”):
Parameter | Value type | Optional? | Description |
---|---|---|---|
dql | string | A DQL TABLE query. |
Return values
These parameters will be added to the callbacks used for getting data back from Actions URI.
On success:
Parameter | Description |
---|---|
result-data | An array containing arrays of strings (the result table), encoded as JSON string. |
On failure:
Parameter | Description |
---|---|
errorCode | A HTTP status code. |
errorMessage | A short summary of what went wrong. |