Skip to main content

 Web service API

How to use PageSeeder's Web service API

get thread progress

/threads/{threadid}/progress [GET]

com.pageseeder.thread.GetThreadProgress

Description

Thread Progress.

This service gets the current progress for an Asynchronous process.

Parameters

No parameters required.

Permission

Only the member that started the thread or an administrator can invoke this service.

Response

This service returns the following XML:

<thread id="[thread id]"
        name="[thread name]"  
        username="[username of user starting thread]"
        groupid="[ID of group if applicable or -1]"
        status="[initialised|
                 inprogress|
                 error|
                 warning|
                 cancelled|
                 failed|
                 complete]">
  [<message>[explanation or error]</message>]
  [thread specific XML]
</thread>

Error Handling

No specific errors expected for this service.

Created on , last edited on