Documents Service / GET

Document Properties Marker

override	false

Short Description Supports queries on projectdoc documents.

Doctype addon-component hide

Name Documents Service / GET hide

Short Name GET hide

Parent

Parent Property

property-name	Name

Audience

Name List

render-no-hits-as-blank	true
addon-component	role
property	Audience

Type

Name List

doctype	addon-component-type
render-no-hits-as-blank	true
property	Type

Subject

Name List

doctype	subject
property	Subject

Tags

Tag List

property	Tags

Iteration


value	filled

hide

Since 1.0

Path

 Parent Property
add-link false
property Path
property-name Path

Deprecated hide

Removed hide

Sort Key 00100 hide

...

Section

title	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.

Section

title	select

The comma-separated names of properties to select from matching documents.

Section

title	from

The comma-separate space keys to select documents from.

Note Box

A value for this parameter is required. Otherwise a query on all spaces will be executed which is heavily consuming resources.

If you really need to query on all spaces, use the @all keyword.

Section

title	where

The constraints to filter documents from selected spaces.

See Search Tips.

Section

title	sort-by

The comma-separated list or properties to sort the documents that are part of the result set.

Section

title	max-hit-count

The maximum number of hits. This is the max count of hits in the result set.

Section

title	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).

Note Box
This parameter is supported since Web API version 1.1. Prior to this version the value of this parameter is ignored.

Section

title	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.

Section

title	start-index

The zero-based index of the first hit in the result set to return. Defaults to zero (0).

Section

title	max-result

The maximum number of hits returned. Defaults to ten (10).

Note Box

While max-hit-count limits the size of the result list, the max-result only limits the size of the expanded documents. Think of max-result as a page size. Move the start-index up by steps of max-result until all documents have been returned.

If start-index and max-result are not specified, all documents of the result set are expanded.

Section

title	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.

Note Box
It is not required to run a query. If the identifiers for the documents to fetch information from is known in advance, simply specify them with the `id-list` parameter.

Section

title	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.

Section

title	Examples

Examples on using the get service.

Display Table

doctype	section
render-mode	definition
restrict-to-immediate-children	true

Section

title	Subordinate Components

Display Table

doctype	addon-component
render-no-hits-as-blank	true
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name

...

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 4

New Version 5

Key

About

Keep up-to-date!

Powered by