Web service API

How to use PageSeeder's Web service API

<task>

Summary

A task is a discussion with a status, and possible a priority, due date, and assignment.

The <task> element extends the <discussion> element but includes attributes (@status, @priority and @due) and an element (<assignedto>) which are specific to tasks.

Usage context

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

Attributes

This element defines the following attributes.

NameTypeRequiredDescription
duexs:dateTimenoWhen the task is due
idxs:longyesThe ID of the task
lastcommentdatexs:dateTimenoThe date of the last comment
lastcommentidxs:longnoThe ID of the last comment
priorityxs:stringnoThe priority of the task
replycountxs:intnoThe number of replies in the thread
statusxs:stringyesThe status of the task
titlexs:stringnoThe title of the task (250)

Note

All the task attributes are generated from the comments. With the exception of the @id attribute, they are susceptible to change every time a new comment (i.e. a reply) is made to the discussion thread.

Attributes which are inherited from the <discussion> element are documented there.

@due

This optional attribute indicates the date and time the task is due, it is computed as the latest due date set on a comment in the discussion thread. Any new comment can change the due date of the task if it is different from the previous one.

@priority

This optional attribute indicates the priority of the task, it is computed as the latest priority set on a comment in the discussion thread. Any new comment can change the priority of the task if it is different from the previous one.

For the possible values of the priority attribute, see the attributes of the <comment> element .

@status

This attribute indicates the status of the task, it is computed as the latest status set on a comment in the discussion thread. Any new comment can change the status of the task if it is different from the previous one.

This attribute is always present for a task.

For the possible values of the priority attribute, see the attributes of the <comment> element.

Examples

Schema

XML Schema

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

<xs:complexType name="task">
  <xs:sequence>
    <xs:element name="uri"        type="uri"        minOccurs="0"/>
    <xs:element name="locator"    type="locator"    minOccurs="0"/>
    <xs:element name="assignedto" type="assignedto" minOccurs="0"/>
  </xs:sequence>
  <xs:attribute name="due"             type="xs:dateTime"/>
  <xs:attribute name="id"              type="id" use="required"/>
  <xs:attribute name="lastcommentdate" type="xs:dateTime"/>
  <xs:attribute name="lastcommentid"   type="id"/>
  <xs:attribute name="priority"        type="xs:string"/>
  <xs:attribute name="replycount"      type="xs:positiveInteger"/>
  <xs:attribute name="status"          type="xs:string" use="required"/>
  <xs:attribute name="title"           type="comment-title"/>
</xs:complexType>

Relax Schema

element discussion {
   attribute due             { xs:dateTime }?,
   attribute id              { xs:long },
   attribute lastcommentdate { xs:dateTime }?, 
   attribute lastcommentid   { xs:long }?, 
   attribute priority        { text }?,
   attribute replycount      { xs:boolean }?,
   attribute status          { text },
   attribute title           {  text { maxLength = "250"} }?,
   uri?
   locator?
   assignedto?
}

Compatibility

See also

Created on , last edited on