Web service API

How to use PageSeeder's Web service API

start uri publish

/members/{member}/groups/{group}/uris/{uri}/publish/start [GET]

com.pageseeder.publish.Start

Description

Start a document or folder publish job.

The target PSML ANT script must already by configured on the Publish Engine.

The Publish Engine on a different PageSeeder server can be used by setting the property publishEngineUrl in the global.properties.

The progress of the job can be monitored by getting the log messages from Service: /members/{member}/publish/check [GET]. The logs can also be accessed via the Admin user interface and are stored under the following location: /WEB-INF/state/logs/publish .

Note

Parameter values can be used in the ANT script via ${ps.param.[name]} after calling the <ps:config /> task. e.g.

<ps:config />
<echo>The xyz parameter is ${ps.param.xyz}</echo>

Parameters

NameDescriptionRequiredTypeDefault value
projectThe project containing the ANT script.yesstring
targetThe target name in the script.yesstring
typeThe type of action import|export|publish|processyesenum
documenttypeThe document type (only applies to PSML documents).nostring
log-levelThe level of logging the script should output info|verbose|warn|error|debugnoenuminfo
ps-param-[name]The value of a parameter for the script.nostring

Permission

Permissions requirements to be updated.

Response

XML returned:

<check date="2018-10-08T14:11:51+11:00">
    <publish id="[job ID]">
        <parameters>
            <param name="ps-userFirstname"
                   value="[first name]" />
            ... 
        </parameters>
        <status>in-progress</status>
        <message logged="false"
                 type="in-progress"
                 target="starting"
                 progress="0">Publish Job started
        </message>
    </publish>
</check>

Error Handling

No specific errors expected for this generator.

Created on , last edited on