create uri workflow
/members/{member}/groups/{group}/uris/{uri}/workflow [POST]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.6900 | 6.2000 | xml, json |
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 starts an asynchronous process.
Workflow tasks might not be available in groups a document is shared to unless they were created after the document was shared.
Parameters
| Name | Description | Required | Type | Default value |
|---|---|---|---|---|
| assignedto | ID of assigned member for workflow ("" means blank value) | no | string | previous workflow assigned member |
| description | The workflow content | no | string | |
| draft | Whether the workflow is a draft. | no | boolean | false |
| due | The workflow due date and time in ISO-8601 format. e.g. 2010-10-25T18:00:00+11:00 ("" means blank value) | no | datetime | previous workflow due date |
| labels | Label values for workflow e.g. Important, Typo | no | string | |
| notify | Send notification flag[silent|minimal|normal|announce] | no | notify | silent |
| notify-async | Whether emails should be sent asynchronously (for slow email servers) | no | boolean | false |
| priority | Priority for workflow e.g. High, Medium, Low ("" means blank value) | no | string | previous workflow priority |
| status | Status for workflow e.g.Initiated , In Progress, Complete, Approved, Suspended, Terminated (required if URI is a folder or for first workflow) | maybe | string | previous workflow status |
Permission
Requires contributor or higher in the group.
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
| Code | Cause / Description |
|---|---|
| 0x120E | The due date is invalid |
| 0x1027 | The assignedto Member ID is invalid |
| 0x122E | The labels parameter is invalid |
| 0x122F | The priority parameter is invalid |
| 0x1230 | The status parameter is invalid |