Web service API

How to use PageSeeder's Web service API

<change>

Summary

This element is used to indicate what change took place in a history event. The attributes on the element will specify what has been modified during the event.

Usage context

Permitted content<description>, <labels>, <assignedto>
Permitted parent<event>

Attributes

This element has the following attributes:

NameTypeRequiredDescription
statusxs:stringnoIf the document workflow status was changed
priorityxs:stringnoIf the document workflow priority was changed
duexs:dateTimenoIf the document workflow due date was changed
versionxs:stringnoIf the document version was changed
titlexs:stringnoIf the document title was changed
docidxs:stringnoIf the document docid was changed

@status

This attribute is specified when the status of the document workflow has changed, its value is the new workflow status.

@priority

This attribute is specified when the priority of the document workflow has changed, its value is the new workflow priority.

@due

This attribute is specified when the due date of the document workflow has changed, its value is the new workflow due date  in format ISO 8601.

@version

This attribute is specified when a version has been created on the document, its value is the new version.

@title

This attribute is specified when the title of the document has been updated, its value is the new document title.

@docid

This attribute is specified when the document ID of the document has changed, its value is the new document ID.

 

Examples

<change title="New document title" />
<change status="Completed" priority="Low" />
<change version="2.1" />

Schema

XML Schema

<xs:element name="change">
  <xs:attribute name="status" type="xs:string" use="optional" />
  <xs:attribute name="priority" type="xs:string" use="optional" />
  <xs:attribute name="due" type="xs:dateTime" use="optional" />
  <xs:attribute name="version" type="xs:string" use="optional" />
  <xs:attribute name="title" type="xs:string" use="optional" />
  <xs:attribute name="docid" type="xs:string" use="optional" />
</xs:complexType>

Relax Schema

element change{
  attribute status { xs:string }?, 
  attribute priority { xs:string }?, 
  attribute due { xs:dateTime }?,
  attribute version { xs:string }?,
  attribute title { xs:string }?,
  attribute docid { xs:string }?
}

Compatibility

See also

Created on , last edited on