schedule publish action
/publish/schedule [POST]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.8200 | 5.8200 | json, xml |
Description
“Pause/continue/start” a scheduled publish job.
Three actions are allowed on a scheduled publish event:
pause– stop this event from running when scheduledcontinue– run this event at scheduled times (‘unpause’ the event)start– run the event immediately (useful for testing)
Parameters
| Name | Description | Required | Type | Default value |
|---|---|---|---|---|
| action | The action on the event (pause|continue|start) | yes | enum | |
| eventid | The ID of the event to update | yes | string |
Permission
Response
Following is an example of the XML returned.
<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>
Error Handling
No specific errors expected for this service.