Skip to main content

 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
  • move
  • modification
  • structure
  • attachedto
  • comment
  • task
  • version
  • workflow
  • edit
  • draft
  • note
  • xref
  • image

Parameters

NameDescriptionRequiredTypeDefault value
authorThe member ID or username of event authornostring
documenttypeThe URI’s document typenostring
eventsComma-separated list of event typesyesstring
folderThe URI’s ancestor foldernostring
fromA start datenodatetimecurrent date - 7 days
labelAn event’s labelnostring
pageThe page to loadnointeger1
pagesizeThe number of results per pagenointeger100
publicationidThe ID of the publication to restrict events tonostring
toAn end datenodatetimecurrent date

Permission

This service is restricted to guest and higher unless the group is accessible to public.

Response

The output has the following format:

<history events="upload,creation,move,modification,
                 structure,attachedto,workflow,
                  version,edit,draft,note,xref,
                  image,comment,task"
         [limitreached="true"]>

  <event id=""
         datetime=""
         type="structure"
         title="Fragment Move">
    <author ...> ... </author>
    <uri ...> ... </uri>
  </event>

  <event id=""
         datetime=""
         type="[upload|creation|move|modification]"
         [labels=""]>
    <author ...> ... </author>
    <uri ...>  ... </uri>
    <change type="path|docid|title|labels|description|path|hosturl"
            from=""
            to=""/>
    ...
  </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 type="status|priority|due|assignedto"
            from=""
            to="">
      [<from>
        <assignedto ...> ... </assignedto>
      </from>]
      [<to>
        <assignedto ...> ... </assignedto>
      </to>]
    </change>
  </event>

  <event id=""
         datetime=""
         type="version"
         title="[version]"
         [labels=""]>
    <author ...> ... </author>
    <uri ...> ... </uri>
    <change type="version"
            from=""
            to=""/>
  </event>

  <event id=""
         datetime=""
         type="task"
         title="[task title]"
         fragment=""
         [labels=""]>
    <author ...> ... </author>
    <uri ...> ... </uri>
    <change type="status|priority|due|assignedto"
            from=""
            to="">
      [<from>
        <assignedto ...> ... </assignedto>
      </from>]
      [<to>
        <assignedto ...> ... </assignedto>
      </to>]
    </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