Skip to main content

 Web service API

How to use PageSeeder's Web service API

<workflow>

Summary

A workflow is a list of workflow steps on a document represented by <comment> elements.

Usage context

Permitted content<assignedto> <uri> <comment>
Permitted parent

Attributes

This element defines the following attributes.

NameTypeRequiredDescription
duexs:dateTimenoWhen the workflow is due.
priorityxs:stringnoThe priority of the workflow.
statusxs:stringyesThe status of the workflow.
statuschangedxs:dateTimenoThe last time the status changed.

Examples

<workflow status="Initiated"
          due="2012-03-10T18:00:00+10:00"
          priority="High"
          statuschanged="2012-03-08T12:34:00+10:00">
  <assignedto id="123" date="2012-03-09T..."> ... </assignedto> 
  <uri id="789"> ... </uri>

  <comment id="123"
           contentrole="Workflow"
           created="2012-03-08T12:34:00+10:00"
           status="Initiated"
           due="2012-03-10T18:00:00+10:00"
           priority="High">
    <title>Cavern stolen!</title>
    <author email="alibaba@fortythieves.com.au"> ... </author>
    <assignedto  id="123" date="2012-03-09T..."> ... </assignedto>
    <content id="789" type="text/plain">
      Please review the treasure.
    </content>
  </comment>
  ...
</workflow>

Schema

XML Schema

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

<xs:complexType name="workflow">
  <xs:sequence>
    <xs:element name="assignedto" type="assignedto" minOccurs="0"/>
    <xs:element name="uri"        type="uri"        minOccurs="0" />
    <xs:element name="comment"    type="comment"    minOccurs="0"
                maxOccurs="unbounded"/>
  </xs:sequence>
  <xs:attribute name="due"             type="xs:dateTime" />
  <xs:attribute name="priority"        type="xs:string" />
  <xs:attribute name="status"          type="xs:string"
                use="required" />
  <xs:attribute name="statuschanged"   type="xs:dateTime" />
</xs:complexType>

Relax Schema

element workflow {
   attribute due             { xs:dateTime }?,
   attribute priority        { text }?,
   attribute status          { text },
   assignedto?
   uri?
   comment*
}

Compatibility

No change since initial API release.

See also

Created on , last edited on