Skip to main content

 Web service API

How to use PageSeeder's Web service API

schedule publish action

/publish/schedule [GET]

com.pageseeder.publish.PublishSchedulerEvents

Description

Loads the events from the Publish Scheduler.

Parameters

NameDescriptionRequiredTypeDefault value
reload-scheduleWhether to reload the events from the config filenobooleanfalse

Permission

Permissions requirements to be updated.

Response

XML returned:

<schedule>
  <event id="d539a5998e9655a62fc7cbcc5d32990e"
         process-id="id-22519237f5d798c8db16b080cc729874"
         finished="true"
         paused="true">
    <project>myproject</project>
    <start>2016-02-15T12:29:00+11:00</start>
    <next>2018-10-06T11:29:00+10:00</next>
    <end>2016-07-26T11:30:00+10:00</end>
    [<status>[in-progress|complete|error|cancel]</status>] 
    <target name="create-document">
      <description>Create Documents</description>
      <param name="max-size" value="10"/>
      <param name="folder" value="reports" />
    </target>
  </event>
  <event ...> ... </event>
  ...
</schedule>

Error Handling

No specific errors expected for this service.

Created on , last edited on