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.

Handles Publishing user interface.

This servlet handles the connections with the Publish Engine and the display of Publish log files.
The connection to the Publish Engine is realized using the property publishEngineUrl from the configuration file global.properties.
The log files are stored under the following location: /WEB-INF/logs/publisher .

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 scriptyesstring
targetThe target name in the scriptyesstring
typeThe type of actionyesenum
documenttypeThe document type (only applies to PSML documents)nostring
log-levelThe level of logging the script should outputnoenuminfo
ps-param-[name]The value of a parameter for the scriptnostring

log-level

info|verbose|warn|error|debug

type

import|export|publish|process

 

Permission

Undocumented permissions requirements.

Response

Undocumented XML response

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>

Error handling

No specific errors expected for this generator.

Created on , last edited on