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

NameDescriptionRequiredTypeDefault value
descriptionThe version content.nostring
labelsGeneral labels for comment (e.g. Important, Typo).nostring
nameThe version number or name.yesstring
notifySend notification flag, e.g. 'silent', 'normal', 'announce'.nostringsilent
notify-asyncWhether emails should be sent asynchronously (for slow email servers).nobooleanfalse

Permission

Permissions requirements to be updated.

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