Web service API

How to use PageSeeder's Web service API

create uri version

/members/{member}/groups/{group}/uris/{uri}/versions [POST]

com.pageseeder.version.CreateVersion

Description

Create a new version

Adds a version to a uri or if the uri is a folder the uris under it.

If the URI is a folder this service will start an Asynchronous process.

Parameters

NameDescriptionRequiredTypeDefault value
name The version number or name yes string
description The version content no string
labels General labels for comment (e.g. Important, Typo) no string
notify Send notification flag, e.g. 'silent', 'normal', 'announce' no enum silent

Permission

Undocumented permissions requirements.

Response

The output has the following format for a non-folder URI:

 <version-creation [warning="warning"]
                   [notify-param-ignored=true"]>
   <version id="[id]"
            name="[version name]"
            created="[date/time]">
     <author id="12" ... >
       <fullname>John Jones</fullname>
     </author>
     <description>[content of version]</description>
     <labels>[labels]</labels>
   </version>
 </version-creation>

The output has the following format for a folder URI:

 <version-creation>
   <thread ...>...</thread>
 </version-creation>

Error handling

No specific errors expected for this service.

Created on , last edited on