Web service API

How to use PageSeeder's Web service API

get uris history

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

com.pageseeder.uri.GetURIsHistory

Description

Load Timeline for multiple URIs

Load the history of events for multiple URIs.

Supported event types are:

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

The output has the following format:


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

Parameters

Name Description Required Type Default value
author the member ID or username of event author no string
documenttype the URI's document type no string
events comma-separated list of event types no string
folder the URI's ancestor folder no string
from a start date no datetime current date - 7 days
label an event's label no string
page the page to load no integer 1
pagesize the number of results per page no integer 100
to an end date no datetime current date

Permission

Undocumented permissions requirements.

Response

Undocumented XML response

The output has the following format:


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

Error Handling

0x100E When the author parameter is invalid

Created on , last edited on