Web service API

How to use PageSeeder's Web service API

create uri workflow

/members/{member}/groups/{group}/uris/{uri}/workflow [POST]

com.pageseeder.uri.CreateWorkflow

Description

Create a new workflow

Adds a workflow step to a uri or if the uri is a folder the uris under it.

If the URI is a folder this service will start an Asynchronous process.

Parameters

NameDescriptionRequiredTypeDefault value
assignedtoID of assigned member for workflownostringprevious workflow assigned member
descriptionThe workflow contentnostring
dueworkflow due date format is yyyy-MM-ddnodateprevious workflow due date
labelslabels for workflow e.g. Important, Typonostring
notifySend notification flag
[silent|normal|announce]
nostringsilent
prioritypriority for workflow e.g. 'High', 'Medium', 'Low'nostringprevious workflow priority
statusstatus for workflow e.g. 'Open', 'Resolved', 'Closed'nostringprevious workflow status

Permission

Undocumented permissions requirements.

Response

<workflow-creation [warning="[warning]"]
                   [notify-param-ignored=true"]>
   <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-creation> 

For a single URI and the following XML for a folder URI

<workflow-creation>
  <thread ...>...</thread>
</workflow-creation> 

Error handling

CodeCause / Description
0x120E Invalid Due Date
0x1027 Invalid Assign To Member ID

Created on , last edited on