start uri publish
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 4.8107 | 5.5914 | xml |
Description
Start a document or folder publish job.
The target PSML ANT script must already be 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 through the Admin user interface and are stored under the following location: /WEB-INF/state/logs/publish .
To invoke this service from ANT use the publish task which will return logs from the publish action and wait until it is finished.
Parameter values can be used in the ANT script using ${ps.param.[name]} after calling the <ps:config /> task. e.g.
<ps:config />
<echo>The xyz parameter is ${ps.param.xyz}</echo>
Parameters
| Name | Description | Required | Type | Default value |
|---|---|---|---|---|
| project | The project containing the ANT script | yes | string | |
| target | The target name in the script | yes | string | |
| type | The type of action export|publish|process | yes | enum | |
| documenttype | The document type (only applies to PSML documents) | no | string | |
| log-level | The level of logging the script should output info|verbose|warn|error|debug | no | enum | info |
| ps-param-[name] | The value of a parameter for the script | no | string |
Permission
Requires guest or higher access to the group.
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 service.