Web service API

How to use PageSeeder's Web service API

check publish

/members/{member}/publish/check [GET]

com.pageseeder.publish.Check

Description

Check the status of a publish job.

Parameters

NameDescriptionRequiredTypeDefault value
jobidThe ID of the job to check.yesstring

Permission

Permissions requirements to be updated.

Response

XML Returned:

<check date="2018-10-08T14:1:51+11:00">
    <publish id="[job ID]">
        <parameters>
            <param name="ps-userFirstname"
                   value="[first name]" /> ... </parameters>
        <status>[in-progress|
                complete|
                error|
                fail|
                cancel]
        </status>
        <message logged="true"
                 type="in-progress"
                 progress="90" />
        <message logged="false"
                 type="info">
            <displayUriPath>
              http://localhost:8282/ps/publish/session/
              GGfJpfB3O8eFoAdfCKV2taRMTLISAb7rLcOM7dpSU/
              report/tutorial/export/system_report_2.docx
            </displayUriPath>
        </message>
        <message logged="false"
                 type="target-end"
                 target="create-consolidated-docx" />
        <message logged="false"
                 type="complete">Publishing Complete</message>
    </publish>
</check>

Only the last <message> from the previous call to this service will be returned, plus any new messages since the last call.

Messages such as <message logged="true" type="in-progress" progress="90" /> are caused by the following in the build.xml but are only returned if the job was started with log-level=verbose.

<echoxml><progress percent="[n]" /></echoxml>

Messages such as <message logged="false" type="info"><displayUriPath>...</displayUriPath></message> can be used to retrieve the result from the job and are are caused by the following in the build.xml

<echoxml><displayUriPath>[url]</displayUriPath></echoxml>

For more information see Publish messages.

Error Handling

No specific errors expected for this service.

Created on , last edited on