You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
Version 1
Next »
Supports queries on projectdoc documents.
The documents service allows to run queries to fetch document identifiers and information from projectdoc documents.
The result can be requested in different media types.
Media Type | Content Type | Extension | Notes |
---|
CSV | text/csv | .csv | Requires the select parameter to be specified to define the order of columns. |
JSON | application/json | .json | No special requirements. |
Microsoft Excel | application/vnd.ms-excel | .xls | Requires the select parameter to be specified to define the order of columns. The file will be written with a filename extension of .csv (since the document is a specialized version of CSV that is recognized with Excel). |
XML | application/xml | .xml | No special requirements. |
Specify the content type with the accept HTTP header or add the extension to the request URL.
Parameters
The parameters allow to specify a query on projectdoc documents. This is similar to the Display Table Macro, but instead of rendering the result list in a table right in the Confluence page, the REST service returns a representation of the list in the specified media format.
select
The comma-separated names of properties to select from matching documents.from
The comma-separate space keys to select documents from.
where
The constraints to filter documents from selected spaces.
See Search Tips.
sort-by
The comma-separated list or properties to sort the documents that are part of the result set.
max-hit-count
The maximum number of hits. This is the max count of hits in the result set.
expand
Define if properties and/or sections should be expanded. Select from property and section. This parameter refers to the representation returned on the request.
If properties and sections should be expanded, do not use blanks in this value (property,section
).
property-filter
A regular expression to match property names of the documents in the result set. Only properties with matching names will be returned as properties of the documents.
The parameter is available since version 1.1.
start-index
The zero-based index of the first hit in the result set to return. Defaults to zero (0
).
max-result
The maximum number of hits returned. Defaults to ten (10
).
id-list
A list of document (aka page) identifiers to return. If empty the query is executed, if non-empty, start-index
and max-result
define the range of documents whose details are returned.
resource-mode
Controls how properties are rendered. Valid values are html
,value
, and storage
(default). This parameter refers to the representation returned on the request.
The parameter is available since version 1.1.