Skip to main content

 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 starts an Asynchronous process.

Parameters

NameDescriptionRequiredTypeDefault value
nameThe version number or nameyesstring
descriptionThe version contentnostring
labelsGeneral label values for comment (e.g. Important, Typo)nostring
notifySend notification flag, e.g. silent, normal, announcenoenumsilent
notify-asyncWhether emails should be sent asynchronously (for slow email servers)nobooleanfalse
publicationidThe ID of the publication associated with the versionnopublicationid

Notify parameter

This parameter must be one of:

  • normal – notify based on each members’ notification settings;
  • announce – ignores members’ individual notifications settings;
  • silent – no notification.

Permission

This service requires approver or above.

Response

If uri is a document, the output has the following format:

<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>

If uri is a folder, the output is:

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

Error Handling

No specific error handling.

Created on , last edited on