ProAbs - Load workflows
API Url
Used for loading ProAbs workflows
http://localhost:16010/ProMarkREST/rest/ProAbs/workflows
Permissions: user
Query parameters
| Field | Type | Description |
|---|---|---|
deptIdoptional | String | Department identifier |
empNooptional | String | Employee Number |
ruleIdoptional | String | Workflow rule identifier |
statusoptional | Number | Workflow status. Workflows with all status gets displayed, if this parameter is not defined. Other possible values: 0: Workflow not started 1: Workflow started 2: workflow completed 3: workflow declined. |
templateIdoptional | String | Workflow template identifier |
Success 200
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| data | Object | Object containing the requested data. |
| workflows | Object | Collection of employee workflows |
| deptDescr | String | Department description |
| deptId | String | Employee department |
| empInitials | String | Employee initials |
| empName | String | Employee Name |
| empNo | String | Employee number |
| from | Date | Workflow start date |
| id | Number | Workflow identifier |
ruleDescroptional | String | Workflow rule description |
| ruleId | String | Workflow rule identifier |
| status | Number | Workflow status. Possible values are: 0: Workflow not started 1: Workflow started 2: workflow completed 3: workflow declined |
templateDescroptional | String | Workflow template description |
| templateId | String | Workflow template identifier |
tooptional | Date | Workflow end date |
messageoptional | Object | Object containing response messages. |
| code | Number | Message code. |
| text | String | Message text. |
| type | String | Type of message. "warning""info" |
Sucess example:
HTTP/1.1 200 OK{"response": {"data": {"workflows": [{"empNo": "24","empName": "Sharmila Thapa","empInitials": "STB","deptId": "AUTHOR","deptDescr": "AUTHOR","templateId": "TEMPA","templateDescr": "Cont. abs","ruleId": "ABC","ruleDescr": "Absence rule description","from": "2018-04-04","to": "2018-04-16","status": 2,"id": 34079}]},"errorCode": 0,"errorMessage": ""}}