...
| Parameter Name | Description |
|---|
| apiKey | Caller system identifier. |
| logonId | User logon id |
| logonProvider | User logon provider. |
| tag | Worklist identifier. If set to null default inbox is returned. |
| start | Start number of list. Use 0 to start from beginning. |
| maxLength | Limit of number of rows in list. Use -1 to get all rows. |
| queryXml | Optional query xml value. |
Example Call
| Request | Response |
|---|
| No Format |
|---|
POST http://ertan.emakin.com/rest.asmx/getWorklist HTTP/1.1
Content-Type: application/json; charset=utf-8
Host: ertan.emakin.com
Content-Length: 91
{
"apiKey": "xxxx",
"logonId": "user@emakin.com",
"logonProvider": "Organization",
"tag": null,
"start": 0,
"maxLength": 30,
"queryXml" : ""
} |
|
| No Format |
|---|
HTTP/1.1 200 OK
Cache-Control: private, max-age=0
Content-Type: application/json; charset=utf-8
Date: Mon, 26 Oct 2015 21:15:17 GMT
Content-Length: 1245
{
"d":[
{
"Id":"e5134318-88bd-4a33-b561-4d78380734ce",
"Caption":"A new task",
"Start":"/Date(1445812020394)/",
"End":null,
"Instructions":"Please complete.",
"State":"Waiting",
"Number":12471
},
{
"Id":"796a34c6-fd2e-450e-a2af-8124ea68f8ca",
"Caption":"A new other task",
"Start":"/Date(1445512843034)/",
"End":null,
"Instructions":"Please complete.",
"State":"Waiting",
"Number":12468
}
]
} |
|
...
| Parameter Name | Description |
|---|
| apiKey | Caller system identifier. |
| logonId | User logon id |
| logonProvider | User logon provider. |
| tag | Worklist identifier. If set to null default inbox is returned. |
| queryXml | Optional query xml value. |
Example Call
| Request | Response |
|---|
| No Format |
|---|
POST http://ertan.emakin.com/rest.asmx/getWorklistCount HTTP/1.1
Content-Type: application/json; charset=utf-8
Host: ertan.emakin.com
Content-Length: 91
{
"apiKey": "xxxx",
"logonId": "user@emakin.com",
"logonProvider": "Organization",
"tag": null,
"queryXml" : ""
} |
|
| No Format |
|---|
HTTP/1.1 200 OK
Cache-Control: private, max-age=0
Content-Type: application/json; charset=utf-8
Date: Mon, 26 Oct 2015 21:15:17 GMT
Content-Length: 8
{
"d":50
} |
|
...
| Request | Response |
|---|
| No Format |
|---|
POST http://ertan.emakin2.com/rest.asmx/trigger HTTP/1.1
Content-Type: application/json; charset=utf-8
Host: ertan.emakin2.com
Content-Length: 124
{
"apiKey": "xxxx",
"logonId": "user@emakin.com",
"logonProvider": "Organization",
"eventName" : "myEvent",
"data": "<pool><eventParameter>ABC</eventParameter></pool>"
} |
|
| No Format |
|---|
HTTP/1.1 200 OK
Cache-Control: private, max-age=0
Content-Type: application/json; charset=utf-8
Date: Mon, 26 Oct 2015 21:23:33 GMT
Content-Length: 516
{
"d": ["716F8FCB-98C2-4591-8C43-043D54DEAADA"]
}
|
|
Query
Query is xml based string that specifies the requested result. If not specified default query is performed.
Query definition uses following column names to be specified as result set column name, criteria and order.
Worklist Columns
| Name | Description |
|---|
| Id | Unique work item identifier |
| Name | Name of work item |
| Caption | Localized caption of work item. |
| State | State of work item. |
| Start | Start date of work item |
| End | End date of work item. Can be null. |
| IsDeadlined | A boolean that specifies the deadline is occurred. |
| DeadlineDate | Deadline date. Can be null. |
| NextReminderDate | Next reminder date. Can be null. |
| SentReminders | Number of sent reminders |
| Instructions | Instructions of work item |
| InstanceId | Unique instance identifier |
| PreviousWorkItemId | Previous id number of work item. Can be null. |
| ActionId | Unique action identifier. Can be null. |
| CompletedById | Id number of completed by user. Can be null. |
| CompletedBy | Display name of completed by user. Can be null. |
| Number | Instance number |
| Priority | Instance priority |
| ProcessId | Id number of process |
| ProcessName | Name of process |
| FromId | Id number of initiator user. Can be null. |
| From | Display name of initiator user. Can be null. |
| FolderId | Id number of related folder id. |
| FolderName | Name of related folder. |
| AssignedTo | List of assigned users |
| VersionNumber | Version number of related process |
| VersionId | Id number of related process version |
| TestMode | A boolean that specifies instance is in test mode or not. |
| Instance.Start | Start date of instance |
| Instance.State | State of instance |
Query contains the following sections;
Columns
List of column names that requested.
Where
List of criteria to be performed. Criteria name can be specified from column names.
Order
List of order to be performed. Order name can be specified from column names.
Example Query Xml
| Code Block |
|---|
|
<Query Start="" MaxLength="25">
<Columns>
<Column Expression="Id"/>
<Column Expression="Instructions"/>
<Column Expression="State"/>
<Column Expression="FromId"/>
<Column Expression="From"/>
<Column Expression="SentReminders"/>
<Column Expression="HasHistory"/>
<Column Expression="Caption"/>
<Column Expression="Start"/>
<Column Expression="DeadlineDate"/>
<Column Expression="End"/>
<Column Expression="FolderName"/>
<Column Expression="Number"/>
</Columns>
<Where>
<Criteria>
<Criteria Expression="Caption" Comparison="Like">
<Value>My Task*</Value>
</Criteria>
</Criteria>
</Where>
<Order>
<Order Expression="Start" Type="Descending" />
</Order>
</Query> |