Web service API

How to use PageSeeder's Web service API

schedule publish action

/publish/schedule [POST]

com.pageseeder.publish.PublishEventAction

Description

"Pause/continue" a scheduled publish job

Three actions are allowed on a publish event: start, pause and continue.

Parameters

NameDescriptionRequiredTypeDefault value
actionThe action on the event (pause|continue|start)yesenum
eventidThe ID of the event to updateyesstring

Permission

Undocumented permissions requirements.

Response

Events look like this:

<event id="my-id"> 
   <start datetime="2010-08-19T07:00:00+10:00" /> 
   <repeat minutes="1" until="2010-07-12T14:42:00+10:00"/> 
   <description>Create Documents</description> 
   <target name="create-document"> 
     <parameters> 
        <parameter name="folder" value="Scheduler_Files" />
     </parameters>
   </target>
</event>

Error Handling

No specific errors expected for this generator.

Created on , last edited on