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

Parameters

NameDescriptionRequiredTypeDefault value
eventsA comma-separated list of types of events to return (all if not specified).nostrings
pageThe page to load.nolong1
pagesizeThe number of results per page.nolong100

Permission

Permissions requirements to be updated.

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

Error Handling

No specific errors expected for this service.

Created on , last edited on