Get the list of workflow applications defined in the system.

Request

Query Params

tenantId

string <varchar>

required

Unique id for a tenant.

Example:

pg

status

string

optional

status of Application

ids

string

optional

Unique id of Application

businessService

string

optional

Name of the workflow confguration.

>= 2 characters<= 64 characters

moduleName

string

optional

Module name to which workflow application belongs

>= 2 characters<= 64 characters

businessIds

string

optional

The list of businessIds

Example:

pgrmnkm001x1iMmm

assignee

string

optional

The unique Old license number for a Application.

>= 2 characters<= 64 characters

history

boolean

optional

Boolean flag to return history of the workflow

Example:

true

limit

integer

optional

Number of records to be returned

offset

integer

optional

Starting offset for returning search response

fromDate

integer

optional

Number of records to be returned

toDate

integer

optional

Number of records to be returned

Header Params

Content-Type

string

optional

Example:

application/json

Body Params text/plain

Example

Example: {"RequestInfo": { "apiId": null, "ver": null, "ts": null, "action": "POST", "did": null, "key": null, "msgId": "5bfa85e7-dfa1-47c8-98b2-747bf552be86", "authToken": "50b80fa6-bec2-438e-a168-ce5ad53770b5" } }

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://unified-dev.digit.org/egov-workflow-v2/egov-wf/process/_search?tenantId=pg&status&ids&businessService&moduleName&businessIds=pgrmnkm001x1iMmm&assignee&history=true&limit&offset&fromDate&toDate' \
--header 'Content-Type: application/json' \
--data-raw '{"RequestInfo": {
        "apiId": null,
        "ver": null,
        "ts": null,
        "action": "POST",
        "did": null,
        "key": null,
        "msgId": "5bfa85e7-dfa1-47c8-98b2-747bf552be86",
        "authToken": "50b80fa6-bec2-438e-a168-ce5ad53770b5"
    }
    }'

Responses

🟢200Application(s) Retrived Successfully

application/json

Body

ResponseInfo

object

optional

ProcessInstances

array[object (ProcessInstance) {20}]

optional

Used for search result and create only

id

string

read-onlyoptional

Unique process instance id (UUID)

>= 2 characters<= 64 characters

tenantId

string

required

Unique Identifier of ULB

>= 2 characters<= 128 characters

businessService

string

required

Business service key.

>= 2 characters<= 128 characters

businessId

string

required

Business id is a unique identifier of a task. eg(Propertyid,
TLid, ServiceRequestid)

>= 2 characters<= 128 characters

action

string

required

Actions are define for each business service.

>= 2 characters<= 128 characters

moduleName

string

required

Module to which process instance belongs to.

>= 2 characters<= 64 characters

state

string

read-onlyoptional

Status will be populate by efengine for each action, if it is configured.

>= 2 characters<= 64 characters

comment

string

optional

consumer can pass the comment on each action.

>= 2 characters<= 64 characters

documents

array[object (Document) {6}]

optional

Documents can be attached with each of the action.

assigner

object

optional

assignes

array [object]

optional

nextActions

array[string]

read-onlyoptional

Wf will return next possible action based on .

stateSla

integer <int64>

optional

Date from when license is valid as epoch.

businesssServiceSla

integer <int64>

optional

Date from when license is valid as epoch.

currentStatus

string

optional

Status after action performed

previousStatus

string

optional

Status before action performed

<= 128 characters

entity

object

optional

rating

integer

optional

Rating for current process instance

>= 1<= 5

escalated

boolean

optional

auditDetails

object

optional

totalCount

integer

optional

Example

{
  "ResponseInfo": {},
  "ProcessInstances": [
    {
      "id": "string",
      "tenantId": "string",
      "businessService": "string",
      "businessId": "string",
      "action": "string",
      "moduleName": "string",
      "state": "string",
      "comment": "string",
      "documents": [
        {
          "id": "string",
          "tenantId": "string",
          "documentType": "string",
          "fileStoreId": "string",
          "documentUid": "string",
          "auditDetails": {}
        }
      ],
      "assigner": {},
      "assignes": [
        {}
      ],
      "nextActions": [
        "string"
      ],
      "stateSla": 0,
      "businesssServiceSla": 0,
      "currentStatus": "string",
      "previousStatus": "string",
      "entity": {},
      "rating": 1,
      "escalated": true,
      "auditDetails": {}
    }
  ],
  "totalCount": 0
}

🟠400Invalid input.