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

NameDescriptionRequiredTypeDefault value
authorThe member ID or username of event author.nostring
documenttypeThe URI's document type.nostring
eventsComma-separated list of event types.nostring
folderThe URI's ancestor folder.nostring
fromA start date.nodatetimecurrent date - 7 days
labelAn event's label.nostring
pageThe page to load.nointeger1
pagesizeThe number of results per page.nointeger100
toAn end date.nodatetimecurrent date

Permission

Permissions requirements to be updated.

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