projectdoc Toolbox

Space shortcuts

Page tree

Versions Compared

Old Version 1

changes.mady.by.user Robert Reiner

Saved on

compared with

New Version Current

changes.mady.by.user Robert Reiner

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionSupports queries on projectdoc documents.
 

Doctypeaddon-componenthide
NameDocuments Service / GEThide
Short NameGEThide
Parent
Parent Property
property-nameName
 

Audience
Name List
render-no-hits-as-blanktrue
addon-componentrole
propertyAudience
 

Type

Name List
doctypeaddon-component-type
render-no-hits-as-blanktrue
namesREST Method
propertyType

 

Subject
Name List
doctypesubject
propertySubject
 

Categories
Name List
doctypecategory
propertyCategories
 

Tags
Tag List
propertyTags
 

Iteration

Iteration
value

filled

finished

hide
ExtensionWeb API Extension
Since1.0
 

Path
projectdoc-transclusion-parent-property
-display-ref
add-linkfalse
property
-name
Parent
Path
referred-
property-namePath
 

Deprecatedhide
Removedhide
Sort Key00100hide
Section
indextrue
show-titlefalse
titleDescription

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 TypeContent TypeExtensionNotes
CSVtext/csv.csvRequires the select parameter to be specified to define the order of columns.
JSONapplication/json.jsonNo special requirements.
Microsoft
Excel		application/vnd.ms-excel.xlsRequires 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).
XMLapplication/xml.xmlNo special requirements.

Specify the content type with the accept HTTP header or add the extension to the request URL.

Section
titleParameters

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
titleselect

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

Section
titlefrom

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
titlewhere

The constraints to filter documents from selected spaces.

See Search Tips.

Section
titlesort-by

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

Section
titlemax-hit-count

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

Section
titleexpand

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
titleproperty-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
titlestart-index

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

Section
titlemax-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
titleid-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
titleresource-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
titleExamples

Examples on using the get service.

Display Table
doctypesection
render-modedefinition
restrict-to-immediate-childrentrue

Section
titleSubordinate Components
Display Table
doctypeaddon-component
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...

Section
titleReferences

Section
titleResources
Transclusion
documentWeb API Extension
idsrest-resources

About

This site is maintained by smartics.

Imprint / Impressum

Data Privacy / Datenschutz 

End User License Agreement (EULA)


To get in touch please send us an e-mail!

smartics email

Keep up-to-date!

Read our

smartics Blog

Follow us on

Twitter YouTube Prezi

Find us on

Bitbucket GitHub Atlassian Marketplace

Powered by




© 2001-2023 smartics - Kronseder & Reiner GmbH