Skip to content
This repository was archived by the owner on Sep 8, 2020. It is now read-only.

Commit 239f3c8

Browse files
authored
Docs
1 parent 4d79f14 commit 239f3c8

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ These are the possible requests to web application (add param `?Namespace={Desir
2222

2323
## Prerequisites
2424

25-
If you work with Ensemble Workflow it is recommended to familiaze yourself with [EnsLib.Workflow](http://docs.intersystems.com/latest/csp/documatic/%25CSP.Documatic.cls?PAGE=CLASS&LIBRARY=ENSLIB&PACKAGE=1&CLASSNAME=EnsLib.Workflow) package. Here's quick primer on the main classes:
25+
If you work with Ensemble Workflow it is recommended to familiarize yourself with [EnsLib.Workflow](http://docs.intersystems.com/latest/csp/documatic/%25CSP.Documatic.cls?PAGE=CLASS&LIBRARY=ENSLIB&PACKAGE=1&CLASSNAME=EnsLib.Workflow) package. Here's a quick primer on the main classes:
2626

2727
| Class | Description |
2828
|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -41,7 +41,7 @@ If you work with Ensemble Workflow it is recommended to familiaze yourself with
4141

4242
## GET tasks
4343

44-
It's the basic and first requst you need to execute after logging in (by authentication method you configured for REST web application). It returns basic information unassigned tasks or tasks assigned to current user, here's how it looks like:
44+
It's the basic and first request you need to execute after logging in (by authentication method you configured for REST web application). It returns basic information unassigned tasks or tasks assigned to a current user, here's how it looks like:
4545

4646
```
4747
{
@@ -86,14 +86,14 @@ Here we can see two tasks, fist assigned to a current user (dev) and second one
8686
| Message | Detailed message body for this task | First 25 symbols only |
8787
| TaskId | Id of EnsLib.Workflow.TaskResponse object | |
8888
| RoleName | The workflow role (EnsLib.Workflow.RoleDefinition) | |
89-
| AssignedTo | Name of the user that has currently has ownership of the associated task (if any). | Either current user or no one |
89+
| AssignedTo | Name of the user that has currently has ownership of the associated task (if any) | Either current user or no one |
9090
| TimeCreated | Creation time | UTC timestamp |
9191
| Age | Age of this item | |
9292
| UserName | Current workflow user (EnsLib.Workflow.UserDefinition) | Current user |
9393

9494
## GET tasks/:id
9595

96-
After you received main information about available tasks, you can see it in more detail, by requesting it by id (`345||dev` in example). Here's how response object looks like:
96+
After you received main information about available tasks, you can see it in more detail, by requesting it by id (`345||dev` in the example). Here's how response object looks like:
9797

9898
```
9999
{
@@ -162,18 +162,18 @@ After you received main information about available tasks, you can see it in mor
162162
}
163163
```
164164

165-
It's just a json representation of [EnsLib.Workflow.Worklist](http://docs.intersystems.com/latest/csp/documatic/%25CSP.Documatic.cls?PAGE=CLASS&LIBRARY=ENSLIB&CLASSNAME=EnsLib.Workflow.Worklist) object.
166-
This request provides enouth information to display task to the user.
165+
It's just a JSON representation of [EnsLib.Workflow.Worklist](http://docs.intersystems.com/latest/csp/documatic/%25CSP.Documatic.cls?PAGE=CLASS&LIBRARY=ENSLIB&CLASSNAME=EnsLib.Workflow.Worklist) object.
166+
This request provides enougth information to display task to the user.
167167

168168
## POST tasks/:id
169169

170-
After user is done working on his task, you need to notify Workflow engine about new state of the task. To do thet, execute this request, with the json representation of EnsLib.Workflow.Worklist object (received from the previous request) as a body.
170+
After a user is done working on a task, you need to notify Workflow engine about a new state of a task. To do that, execute this request, with the JSON representation of EnsLib.Workflow.Worklist object (received from the previous request) as a body.
171171
To express changes made by user, modify EnsLib.Workflow.Worklist object:
172172

173-
- Set `Task.%Action` property to one of %Actions values or `$Accept` to accept task, `$Relinquish` to relinquish task and `$Save` to save changes made to task
174-
- Provide `Task.%FormValues` as an array with kays from `%FormFields` and values provided from a client
173+
- Set `Task.%Action` property to one of %Actions values or `$Accept` to accept a task, `$Relinquish` to relinquish task and `$Save` to save changes made to a task
174+
- Provide `Task.%FormValues` as an array with keys from `%FormFields` and values provided by a client
175175

176-
Here's an example of user completing `345||dev` task (by choosing Corrected action):
176+
Here's an example of a user completing `345||dev` task (by choosing Corrected action):
177177

178178
```
179179
{

0 commit comments

Comments
 (0)