Web service API

How to use PageSeeder's Web service API

create publication version

/members/{member}/groups/{group}/publications/{publicationid}/version [POST]

com.pageseeder.version.CreateVersionForPublication

Description

Versions all documents in a publication.

Starting at publication root URI adds versions to all XRef target URIs. If XRef type="embed" with a PSML target URI it recursively processes the target URI's XRefs as well (if target is a fragment it only follows XRefs for that fragment).

Invoking this service will start an Asynchronous process.

Parameters

Name Description Required Type Default value
description The version content no string
labels General labels for comment (e.g. Important, Typo) no string
name The version number or name yes string
notify Send notification flag, e.g. 'silent', 'normal', 'announce' no string silent
notify-async Whether to send emails asynchronously (for slow email servers) no boolean false

Permission

Undocumented permissions requirements.

Response


 <version-creation>
   <thread id="123"...>
     [thread XML]
   </thread>
 </version-creation>
 

Error Handling

No specific errors expected for this generator.

Created on , last edited on