Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section


Column
width144px

Display Property
property-nameLogo


Column


Document Properties Marker
overridefalse


Short DescriptionAdd-on to extend projectdoc with an API to access on the web.
Doctypetopichide
NameWeb API Extension
Parent
Parent Property
propertyParent
property-nameName

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience

Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
propertyLevel of Experience

Expected Duration
Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
names/ projectdoc / Extension
propertyCategories

Tags
Tag List
propertyTags

Iteration

Iteration
valueproduction

hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
propertyType

Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

Version6.1.0
Status

Status
colourGreen
titleAvailable

hide
Non-Public Betanonehide
Logo
hide
Marketplace URLhttps://marketplace.atlassian.com/1215409hide
projectdoc Toolbox4.1.1
Pathrest/projectdoc/1hide
Sort Keyhide




Column

Panel
titleContents

Table of Contents
maxLevel2
indent10px
excludeWeb API Extension
stylenone



...

Section
titleAccessing the API

There are different approaches to access the web API provided by the projectdoc Toolbox via this extension.

Section
titleREST API Browser


Transclusion
documentREST API Browser
idsSummary




Section
titleUserscripts

The Web API can be used with userscripts. Userscripts are typically short scripts that are executed in the user's browser.

Userscripts may be added to a browser by the use of a browser extension. Users selectively install and employ the scripts they want to execute in their browser.

You may also choose to deploy the userscripts to execute by the Confluence Administrators. The app

Static Document Link
documentuserscripts:Userscripts for Confluence
(commercial license) is one option to integrate such userscripts easily.


Section
titleBookmarklets

The Bookmarklets Extension (free app) allows to integrate calls to the web API into the user's browser.

With bookmarklets services are brought to the fingertips of the users. The organization of bookmarks can be personalized very easily.

The Bookmarklets Extension provides a number of bookmarklets to get started. With the Bookmarklet Editor these bookmarklets can be loaded and installed. The editor also allows to create new bookmarklets.

An overview over projectdoc bookmarklets is available on Bookmarklets List Macro.


Section
titlecURL

There are a lot of tools and programming libraries to use REST APIs.

cURL is one example to integrate information from projectdoc documents into remote information systems.


...