Skip to main content

 Services

Web services from /about to /webhooks

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

Parameters

NameDescriptionRequiredTypeDefault
eventsA comma-separated list of types of events to return (all if not specified)nostrings
pageThe page to loadnolong1
pagesizeThe number of results per pagenolong100

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,
                 workflow,version,edit,draft,
                 note,xref,image,comment,task"
         [limitreached="true"]>
  <event id="" 
         datetime="" 
         type="structure" 
         title="Fragment Move">
    <author ...> ... </author>
  </event>
  <event id=""  
         datetime="" 
         type="[upload|creation|move|modification|revert]" 
         [labels=""]
         [version=""]>
    <author ...> ... </author>
    <change type="path|docid|title|labels|description|path|hosturl"
            from=""
            to=""/>
    ...
  </event>
  <event id="" 
         datetime="" 
         type="comment"
         title="[comment title]" 
         fragment="" 
         [labels=""]>
    <author ...> ... </author>
  </event>
  <event  id="" 
          datetime=""
          type="workflow" 
          [labels=""]>
    <author ...> ... </author>
    <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>
    <change type="version"
      from=""
      to=""/>
  </event>
  <event id="" 
         datetime="" 
         type="task"
         title="[task title]"
         fragment="" 
         [labels=""]>
    <author ...> ... </author>
    <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>
  </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