-
Notifications
You must be signed in to change notification settings - Fork 64
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
35 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,51 +1,58 @@ | ||
| #The Workflow Service | ||
| The main resource /workflow is uses to read Workitems and Workitem collections through the Imixs Rest Service Interface. | ||
| The Imixs-Workflow REST service interface provides different resources located under */workflow* to access and modifiy workitems. | ||
|
|
||
|
|
||
| ## The /workflow GET resources | ||
| The /workflow resources are used to get the business objects provided by the Imixs Workflow Manager: | ||
| ## GET Workitem Resource | ||
| The resource /workflow/workitem returns a single workitem or meta data: | ||
|
|
||
| | URI | Description | | ||
| |-----------------------------------------------|-------------------------------------------| | ||
| | /workflow/worklist/{user} | a collection of workitems representing the worklist by a specific user (or value 'null' for the current user)| | ||
| | /workflow/worklistbycreator/{creator} | a collection of workitems created by a specific user (or value 'null' for the current user) | | ||
| | /workflow/worklistbyprocessid/{processid} | a collection of workitems in a specific process state | | ||
| | /workflow/worklistbygroup/{processgroup} | a collection of workitems in a specific process group | | ||
| | /workflow/worklistbyowner/{owner} | a collection of workitems owned by a specific user (or value 'null' for the current user) | | ||
| | /workflow/worklistbywriteaccess | a collection of workitems where the current has a write access | | ||
| | /workflow/worklistbyref/{uniqueid} | a collection of workitems referenced to a specific uniqueid (childs) | | ||
| | /workflow/worklistbyquery/{query} | a collection of workitems specified by a JPQL phrase | | ||
| | /workflow/worklistcountbyquery/{query} | the count of workitems returned by a JPQL phrase | | ||
| | /workflow/workitem/{uniqueid} |a single workitem represented by the provided uniqueid | | ||
| | /workflow/workitem/{uniqueid} | a single workitem represented by the provided uniqueid | | ||
| | /workflow/workitem/{uniqueid}/file/{file} | a file attachment located in the property $file of the spcified workitem | | ||
|
|
||
|
|
||
| ## The /worflow resources PUT and POST | ||
| The /workflow/xxxx PUT and POST resources URIs are used to write business objects: | ||
| ## GET Task List Resources | ||
| The resource /workflow/tasklist/ returns collections of workitems: | ||
|
|
||
| | URI | Description | | ||
| |-----------------------------------------------|-------------------------------------------| | ||
| | /workflow/tasklist/{user} | a collection of workitems representing the worklist by a specific user (or value 'null' for the current user)| | ||
| | /workflow/tasklist/creator/{creator} | a collection of workitems created by a specific user (or value 'null' for the current user) | | ||
| | /workflow/tasklist/processid/{processid} | a collection of workitems in a specific process state | | ||
| | /workflow/tasklist/group/{processgroup} | a collection of workitems in a specific process group | | ||
| | /workflow/tasklist/owner/{owner} | a collection of workitems owned by a specific user (or value 'null' for the current user) | | ||
| | /workflow/tasklist/ref/{uniqueid} | a collection of workitems referenced to a specific uniqueid (childs) | | ||
| | /workflow/tasklist/query/{query} | a collection of workitems specified by a JPQL phrase | | ||
| | /workflow/tasklist/query/count/{query} | the count of workitems returned by a JPQL phrase | | ||
|
|
||
|
|
||
|
|
||
| ## PUT/POST Workitem or Task List | ||
| The following resource URIs are used to PUT and POST a wokitem or a task list: | ||
|
|
||
|
|
||
| | URI | Description | | ||
| |------------------------------|-------------------------------------------| | ||
| | /workflow/workitem | posts a workitem to be processed by the workflow manager. The post data can be x-www-form-urlencoded or in xml format | | ||
| | /workflow/workitem/{uniqueid}| posts a workitem to be processed by the workflow manager. The post data can be x-www-form-urlencoded or in xml format | | ||
| | /workflow/worklist | posts a worklist to be processed by the workflow manager. The post data can be x-www-form-urlencoded or in xml format | | ||
| | /workflow/workitem.json | posts a workitem to be processed by the workflow manager. The post data is expected in json format. The result in json format | | ||
| | /workflow/workitem.json/{uniqueid} | posts a workitem to be processed by the workflow manager. The post data is expected in json format. The result in json format | | ||
| | /workflow/tasklist | posts a list of workitems to be processed by the workflow manager. The post data can be x-www-form-urlencoded or in xml format | | ||
|
|
||
|
|
||
|
|
||
| ## Resource Options | ||
| You can specify additional URI parameters to filter the resultset or to navigate through a sub list of workitems. Append optional arguments to define the number of workitems returned by a URL, the starting point inside the list or the sort order. Combine any of the following arguments for the desired result. | ||
| Additional URI parameters can be used to filter the result set, or to navigate through a sub list of the result set. | ||
|
|
||
|
|
||
| | option | description | example | | ||
| |-------------|-----------------------------------------------------|-----------------------| | ||
| | count | number of workitems returned by a collection | ..?count=10 | | ||
| | start | position to start workitems returned by a collection | ..?start=5&count=10 | | ||
| | type | Optional type property workitems are filtered | ..?type=workitem | | ||
| | sortorder | defines the sortorder of the returned collection <br /> (0=creation date descending <br />,1=creation date ascending<br />,2=modified date descending<br />,3=modified date ascending) |&sortorder=2 | | ||
| | count | number of workitems to be returned by a collection | ..?count=10 | | ||
| | start | start position of a collection of workitems | ..?start=5&count=10 | | ||
| | type | filter workitems by the 'type' property | ..?type=workitem | | ||
| | sortorder | sortorder of the returned collection <br /> (0=creation date descending <br />,1=creation date ascending<br />,2=modified date descending<br />,3=modified date ascending) |&sortorder=2 | | ||
|
|
||
| <strong>Note:</strong> The Imixs JEE Workflow manages the access to workitems by individual access lists per each entity. So the result of a collection of workitems will only contain entities where the current user has a read access right. Without access the workitem will not be returned by the workflowManager and so it will not be included in the list. | ||
| <strong>Note:</strong> The Imixs-Workflow manages the access to workitems by individual access lists per each entity. The result of a collection of workitems depends on the current user accesslevel and read access permissions for a workitem. Read also the section [Access Control](/engine/acl.html) for further information. | ||
|
|
||
|
|