ProAbs - Load workflow steps

API Url

Used for loading workflow steps of selected workflow.

GET
http://localhost:16010/ProMarkREST/rest/ProAbs/workflows/{id}/steps

Permissions: user

Path parameters

FieldTypeDescription
idNumber

Workflow identifier

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    stepsObject

Collection of workflow steps

      commentoptionalString

Comment

      deadlineoptionalDate

deadline

      descriptionoptionalString

Step description

      eventDescroptionalString

Event Description

      eventErroroptionalString

Event error if any

      eventIdoptionalString

Event Identifier

      eventResultoptionalString

Event Result

      fromoptionalDate

Start date

      idNumber

Step identifier

      incarnationNumber

Incarnation of the "step sequence".

      isExecutedoptionalBoolean

If event executend or not.

      notificationStatusoptionalNumber

Notification Status, possible values:
0 = Notification waiting to be created,
1 = Notification created, 2 = Notification canceled, 9 = No notification for this line

      orderString

Sorting order

      tooptionalDate

End date

      typeNumber

Workflow Step types, possible values are: 1:Starting 2:Continuation 3:Termination

      workflowIdNumber

Workflow identifier

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Response example:

{
"response": {
"data": {
"steps": [
{
"workflowId": 34080,
"order": "11",
"deadline": "2018-05-31",
"eventResult": "Created in ProMark",
"type": 1,
"incarnation": 1,
"id": 1,
"description": "became ill"
},
{
"workflowId": 34080,
"order": "31",
"deadline": "2018-08-29",
"eventResult": "Created in ProMark",
"notificationStatus": 9,
"type": 3,
"incarnation": 1,
"id": 1,
"description": "Back on work"
}
]
},
"errorCode": 0,
"errorMessage": ""
}
}