Skip to main content

 Web service API

How to use PageSeeder's Web service API

<history>

Summary

The element <history> is used to output the list of events on a URI (document or URL).

Usage context

Permitted content<event>
Permitted parent

Attributes

This element includes the following attributes.

NameTypeRequiredDescription
limitreachedxs:booleannoWhether the maximum number of events has been reached.
eventsxs:stringyesA comma-separated list of event types included in the history.

@limitreached

This optional attribute is only provided when the maximum number of events has been reached. It is used to know if more history events can be loaded.

@events

This attribute is used to know which events are included in the output. It is a comma-separated list of event types which can be:

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

Examples

<history events="creation,modification,edit,draft,xref">
  <event id="1224"
         datetime="2017-03-06T16:43:42+11:00"
         type="modification">
    <author id="71"
            firstname="Alan"
            surname="Smith"
            username="asmith"
            status="activated">
      <fullname>Alan Smith</fullname>
    </author>
    <change title="First document" />
  </event>
  <event id="1225"
         datetime="2017-03-06T16:43:42+11:00"
         type="creation">
    <author id="71"
            firstname="Alan"
            surname="Smith"
            username="asmith"
            status="activated">
      <fullname>Alan Smith</fullname>
    </author> 
  </event>
  <event id="1234"
         datetime="2017-03-06T16:43:42+11:00"
         type="edit"
         fragment="context">
    <author id="18"
            firstname="Alice"
            surname="Jones"
            username="ajones"
            status="activated">
      <fullname>Alice Jones</fullname>
    </author>
  </event>
  <event id="1235"
         datetime="2017-03-06T16:47:07+11:00"
         type="xref"
         fragment="context"
         title="target document"
         uriid="48512"
         targetfragment="default">
    <author id="18"
            firstname="Alice"
            surname="Jones"
            username="ajones"
            status="activated">
      <fullname>Alice Jones</fullname>
    </author>
  </event>
</history>

Schema

XML Schema

<xs:element name="history" type="history" />

  <xs:complexType name="history">
    <xs:sequence>
      <xs:element ref="event" minOccurs="1" maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="limitreached"
                  type="xs:boolean"
                  use="optional"
                  default="false"/>
  <xs:attribute name="events" type="xs:string" />
</xs:complexType>

Relax Schema

element history {
   attribute limitreached { xs:boolean }?,
   attribute events       { xs:string },
   element event+
}

Compatibility

No change since initial API release.

See also

Created on , last edited on