Accessing projectdoc Space Properties with cURL

Versions Compared

Old Version 4

changes.mady.by.user Anton Kronseder

Saved on 15. Sep 2016

compared with

New Version Current

changes.mady.by.user Robert Reiner

Saved on 03. Aug 2017

Key

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

Section

Column

Document Properties Marker

override	false

Short Description	Learn how to access projectdoc space properties via REST API with cURL.


Doctype	topic	hide
Name	Accessing projectdoc Space Properties with cURL

Parent

Parent Property

property	Parent
property-name	Name

Audience

Name List

doctype	role
render-no-hits-as-blank	true
render-list-as-comma-separated-values	true
names	Author, Documentation Architect, Documentation Gardener
property	Audience
empty-as-none	false

Level of Experience

Name List

doctype	experience-level
render-no-hits-as-blank	true
names	Advanced Beginner
property	Level of Experience
empty-as-none	false

Expected Duration

15 min

Subject

Name List

doctype	subject
property	Subject

Sponsors

Name List

doctype	stakeholder
render-no-hits-as-blank	true
property	Sponsors


Sort Key		hide

Column

width	45%

Panel

title	Contents

Table of Contents

maxLevel	2
indent	15px
style	none

...

Section

title	Executing REST Calls

After having installed the projectdoc Web API Extension to your Confluence instance choose a login method and start using the REST API. All the following examples use a cookie based login but feel free to take another choice.

This section will provide some examples how to get you started.

Let's assume you have already created a projectdoc workspace .

Section

title	Query the Properties of a projectdoc Space

Query the newly created projectdoc space for its properties. To build such a query you need the space key of the space. Just choose "Overview" of the "Space tools" actions and retrieve it from the overview page.

Another option is to use the following JavaScript command in the console of your browser: AJS.params.spaceKey

Note Box
This tip addresses all Web API Extension versions since 1.0. Starting with Version 1.1 it is mandatory to use the request parameter `expand=property` to retrieve properties. For older versions this property does not exist.

Now let us use this page ID in your first query:

Code Block Placeholder

code-theme	Midnight
code-language	Bash
code-title	Query the properties of a projectdoc document

curl -s --cookie /tmp/confluence.cookie \
	https://www.example.com/confluence/rest/projectdoc/1/space/home.json?expand=property | jq.

Here you can see the response:

Code Block Placeholder

code-theme	SpaceDefault
code-language	Bash
code-title	Response

 {
  "id": 950274,
  "property": [
    {
      "source": "IDX",
      "name": "Categories",
      "value": ""
    },
    {
      "source": "IDX",
      "name": "documentation-json-uri",
      "value": "https://www.smartics.eu/confluence/download/attachments/12156954/docmap.json?api=v2"
    },
...

Besides JSON you can also get the response as XML. Just omit the extension or use .xml as extension:

Code Block Placeholder

code-theme	Midnight
code-language	Bash
code-title	Query the properties of a projectdoc document (xml)

curl -s --cookie /tmp/confluence.cookie \
	https://www.example.com/confluence/rest/projectdoc/1/space/home?expand=property | xmlstarlet  format --indent-tab
or
curl -s --cookie /tmp/confluence.cookie \
	https://www.example.com/confluence/rest/projectdoc/1/space/home.xml?expand=property | xmlstarlet  format --indent-tab

Code Block Placeholder

code-theme	SpaceDefault
code-language	Bash
code-title	Response (xml)

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<space id="950274">
        <property>
                <source>IDX</source>
                <name>Categories</name>
                <value/>
        </property>
        <property>
                <source>IDX</source>
                <name>documentation-json-uri</name>
                <value>https://www.smartics.eu/confluence/download/attachments/12156954/docmap.json?api=v2</value>
        </property>
...

Section

title	Receiving Property Names, Values or both

If you would like to receive the values in a compact form use the following expression:

Code Block Placeholder

code-theme	Midnight
code-language	Bash
code-title	Query the properties of a projectdoc document (pretty)

curl -s --cookie /tmp/confluence.cookie \
	https://www.example.com/confluence/rest/projectdoc/1/space/home.json?expand=property | \
	jq   '[.property[] | { key : .name , value: .value}] | from_entries '

Code Block Placeholder

code-theme	SpaceDefault
code-language	Bash
code-title	Response

{
  "Categories": "",
  "documentation-json-uri": "https://www.smartics.eu/confluence/download/attachments/12156954/docmap.json?api=v2",
  "DocumentPropertyRefs": "",
  "extract-short-description-from-metadata-table": "true",
  ...
}

Other possibilities are analogue to Accessing projectdoc Properties with cURL.

Section

title	Receive a single Property

Receiving only one property by accessing it explicitly (instead of filtering for it).

get the full property
get only the value
get the value without quotes

Code Block Placeholder

code-theme	Midnight
code-language	Bash
code-title	Receive a single property

curl -s --cookie /tmp/confluence.cookie \
	https://www.example.com/confluence/rest/projectdoc/1/space/home/property/extract-short-description-from-metadata-table.json?expand=property | jq .
or
curl -s --cookie /tmp/confluence.cookie \
	https://www.example.com/confluence/rest/projectdoc/1/space/home/property/extract-short-description-from-metadata-table.json?expand=property | jq .value
or
curl -s --cookie /tmp/confluence.cookie \
	https://www.example.com/confluence/rest/projectdoc/1/space/home/property/extract-short-description-from-metadata-table.json?expand=property | jq -r .value

Code Block Placeholder

code-theme	SpaceDefault
code-language	Bash
code-title	Responses

Full property:
 
{
  "source": "IDX",
  "name": "extract-short-description-from-metadata-table",
  "value": "true"
}

Only the value:
 
"true"
 
The value without quotes:
 
true

If the property (key) contains special characters which can not be part of an URL, they have to be escaped. For an example see how we solved this in the tip Accessing projectdoc Properties with cURL.

Section

title	Resumé

Section

title	Subordinate Topics

Display Table

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

...

Section

title	References

REST Login to Confluence with cURL -
Display Property
document REST Login to Confluence with cURL
property-name Short Description
Accessing projectdoc Properties with cURL -
Display Property
document Accessing projectdoc Properties with cURL
property-name Short Description
REST API Browser - Confluence Built-in API client to execute available methods and examine responses.
Confluence REST API Examples - This page contains examples of using the Confluence Content REST API using curl
JQ - a lightweight and flexible command-line JSON processor
xmlstarlet - Command Line XML Toolkit

Section

title	Resources

Piwik Set Multiple Custom Variables

Name	Value
Department	projectdoc
Category	projectdoc-tip
Type	howto

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 Current

Key

About

Keep up-to-date!

Powered by