Web service API

How to use PageSeeder's Web service API

get uri history

/groups/{group}/uris/{uri}/history [GET]

com.pageseeder.uri.GetURIHistory

Description

Load the history of events for a specified URI (most recent first).

Supported event types are:

  • upload
  • creation
  • modification
  • attachedto
  • comment
  • task
  • version
  • workflow
  • edit
  • draft
  • note
  • xref
  • image

Parameters

NameDescriptionRequiredTypeDefault value
events A comma-separated list of types of events to return (all if not specified) no strings
page The page to load no long 1
pagesize The number of results per page no long 100

Permission

Undocumented permissions requirements.

Response

The output has the following format:

   <history events="upload,creation,modification,attachedto,workflow,version,
                    edit,draft,note,xref,image,comment,task">
     <event id="" datetime="" type="[upload|creation|modification]">
       <author ...> ... </author>
       <change path="" docid="" title="">
         <description>...</description>
         <labels> .... </labels>
       </change>
     </event>
     <event id="" datetime="" type="[attachedto|comment]" title="[comment title]" fragment="">
       <author ...> ... </author>
       <labels> .... </labels>
     </event>
     <event id="" datetime="" type="workflow">
       <author ...> ... </author>
       <labels> .... </labels>
       <change status="" priority="" due="">
         <assignedto ...> ... </assignedto>
       </change>
     </event>
     <event id="" datetime="" type="version">
       <author ...> ... </author>
       <labels> .... </labels>
       <change version="" />
     </event>
     <event id="" datetime="" type="task" title="[task title]" fragment="">
       <author ...> ... </author>
       <labels> .... </labels>
       <change status="" priority="" due="">
         <assignedto ...> ... </assignedto>
       </change>
     </event>
     <event id="" datetime="" type="[edit|draft]" fragment="">
       <author ...> ... </author>
       <labels> .... </labels>
     </event>
     <event id="" datetime="" type="note" fragment="">
       <author ...> ... </author>
       <labels> .... </labels>
     </event>
     <event id="" datetime="" type="[xref|image]" title="[target title]" fragment="" uriid="" [targetfragment=""]>
       <author ...> ... </author>
       <labels> .... </labels>
     </event>
   </history>

Error handling

No specific errors expected for this service.

Created on , last edited on