ProAbs - Load workflows

API Url

Used for loading ProAbs workflows

GET
http://localhost:16010/ProMarkREST/rest/ProAbs/workflows

Permissions: user

Query parameters

FieldTypeDescription
deptIdoptionalString

Department identifier

empNooptionalString

Employee Number

ruleIdoptionalString

Workflow rule identifier

statusoptionalNumber

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.

templateIdoptionalString

Workflow template identifier

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    workflowsObject

Collection of employee workflows

      deptDescrString

Department description

      deptIdString

Employee department

      empInitialsString

Employee initials

      empNameString

Employee Name

      empNoString

Employee number

      fromDate

Workflow start date

      idNumber

Workflow identifier

      ruleDescroptionalString

Workflow rule description

      ruleIdString

Workflow rule identifier

      statusNumber

Workflow status. Possible values are: 0: Workflow not started 1: Workflow started 2: workflow completed 3: workflow declined

      templateDescroptionalString

Workflow template description

      templateIdString

Workflow template identifier

      tooptionalDate

Workflow end date

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"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": ""
}
}