Workflow v2

Create new workflow entry for a given application number(businessId).

To create new workflow applicationin the system. API supports bulk creation with max limit as defined in the Trade License Request. Please note that either whole batch succeeds or fails, there's no partial batch success. To create one workflow(ProcessInstance) instance, please pass array with one workflow(ProcessInstance) object.

Following Conditions are applied -

1. Valid action is send according to workflow configuration defined
2. supportDocuments to perform workflow action will created. In case of not attaching the Mandatory Supported Documents creation of workflow Fails.
3. Application will move to next state if valid action is passes.

post

/process/_transition

Body

RequestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProcessInstancesobject[] · min: 1 · max: 100

Used for search result and create only

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-wf/process/_transition' \
  --header 'Content-Type: application/json'

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProcessInstances": [
    {
      "id": "text",
      "tenantId": "text",
      "businessService": "text",
      "businessId": "text",
      "action": "text",
      "state": "text",
      "comment": "text",
      "assigner": {
        "id": 1,
        "userName": "text",
        "password": "super-secret",
        "salutation": "text",
        "name": "text",
        "mobileNumber": "text",
        "emailId": "text",
        "altContactNumber": "text",
        "pan": "text",
        "aadhaarNumber": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPincode": "text",
        "correspondenceCity": "text",
        "correspondencePincode": "text",
        "correspondenceAddress": "text",
        "active": true,
        "dob": "2025-02-22",
        "pwdExpiryDate": "2025-02-22",
        "locale": "text",
        "signature": "text",
        "accountLocked": true,
        "fatherOrHusbandName": "text",
        "identificationMark": "text",
        "photo": "text",
        "createdBy": 1,
        "createdDate": "2025-02-22",
        "lastModifiedBy": 1,
        "lastModifiedDate": "2025-02-22",
        "otpReference": "text",
        "tenantId": "text",
        "roles": [
          {
            "id": 1,
            "name": "text",
            "code": "text",
            "description": "text",
            "createdBy": 1,
            "createdDate": "2025-02-22",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-02-22",
            "tenantId": "text"
          }
        ],
        "gender": [
          "MALE"
        ],
        "type": [
          "EMPLOYEE"
        ],
        "bloodGroup": [
          "A+"
        ]
      },
      "sla": 1,
      "currentStatus": "text",
      "previousStatus": "text",
      "entity": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "documents": [
        {
          "id": "text",
          "tenantId": "text",
          "documentType": "text",
          "fileStoreId": "text",
          "documentUid": "text",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "assignes": [
        {
          "id": 1,
          "userName": "text",
          "password": "super-secret",
          "salutation": "text",
          "name": "text",
          "mobileNumber": "text",
          "emailId": "text",
          "altContactNumber": "text",
          "pan": "text",
          "aadhaarNumber": "text",
          "permanentAddress": "text",
          "permanentCity": "text",
          "permanentPincode": "text",
          "correspondenceCity": "text",
          "correspondencePincode": "text",
          "correspondenceAddress": "text",
          "active": true,
          "dob": "2025-02-22",
          "pwdExpiryDate": "2025-02-22",
          "locale": "text",
          "signature": "text",
          "accountLocked": true,
          "fatherOrHusbandName": "text",
          "identificationMark": "text",
          "photo": "text",
          "createdBy": 1,
          "createdDate": "2025-02-22",
          "lastModifiedBy": 1,
          "lastModifiedDate": "2025-02-22",
          "otpReference": "text",
          "tenantId": "text",
          "roles": [
            {
              "id": 1,
              "name": "text",
              "code": "text",
              "description": "text",
              "createdBy": 1,
              "createdDate": "2025-02-22",
              "lastModifiedBy": 1,
              "lastModifiedDate": "2025-02-22",
              "tenantId": "text"
            }
          ],
          "gender": [
            "MALE"
          ],
          "type": [
            "EMPLOYEE"
          ],
          "bloodGroup": [
            "A+"
          ]
        }
      ],
      "nextActions": [
        "text"
      ]
    }
  ]
}

ReponseInfo with Workflow(s) created successfully

Get the list of workflow applications defined in the system.

1. Search and get Application(s) based on defined search criteria.
2. In case multiple parameters are passed Application(s) will be searched as an AND combination of all the parameters.

post

/_search

Query parameters

idsinteger · int64[]

unique identifier of Application

businessServicestring · min: 2 · max: 64

Name of the workflow confguration.

moduleNamestring · min: 2 · max: 64

Module name to which workflow application belongs

businessIdsstring[]

The list of businessIds

assigneestring · min: 2 · max: 64

The unique Old license number for a Application.

historyboolean

Boolean flag to return history of the workflow

limitinteger

Number of records to be returned

offsetinteger

Starting offset for returning search response

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-wf/_search'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProcessInstances": [
    {
      "id": "text",
      "tenantId": "text",
      "businessService": "text",
      "businessId": "text",
      "action": "text",
      "state": "text",
      "comment": "text",
      "assigner": {
        "id": 1,
        "userName": "text",
        "password": "super-secret",
        "salutation": "text",
        "name": "text",
        "mobileNumber": "text",
        "emailId": "text",
        "altContactNumber": "text",
        "pan": "text",
        "aadhaarNumber": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPincode": "text",
        "correspondenceCity": "text",
        "correspondencePincode": "text",
        "correspondenceAddress": "text",
        "active": true,
        "dob": "2025-02-22",
        "pwdExpiryDate": "2025-02-22",
        "locale": "text",
        "signature": "text",
        "accountLocked": true,
        "fatherOrHusbandName": "text",
        "identificationMark": "text",
        "photo": "text",
        "createdBy": 1,
        "createdDate": "2025-02-22",
        "lastModifiedBy": 1,
        "lastModifiedDate": "2025-02-22",
        "otpReference": "text",
        "tenantId": "text",
        "roles": [
          {
            "id": 1,
            "name": "text",
            "code": "text",
            "description": "text",
            "createdBy": 1,
            "createdDate": "2025-02-22",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-02-22",
            "tenantId": "text"
          }
        ],
        "gender": [
          "MALE"
        ],
        "type": [
          "EMPLOYEE"
        ],
        "bloodGroup": [
          "A+"
        ]
      },
      "sla": 1,
      "currentStatus": "text",
      "previousStatus": "text",
      "entity": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "documents": [
        {
          "id": "text",
          "tenantId": "text",
          "documentType": "text",
          "fileStoreId": "text",
          "documentUid": "text",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "assignes": [
        {
          "id": 1,
          "userName": "text",
          "password": "super-secret",
          "salutation": "text",
          "name": "text",
          "mobileNumber": "text",
          "emailId": "text",
          "altContactNumber": "text",
          "pan": "text",
          "aadhaarNumber": "text",
          "permanentAddress": "text",
          "permanentCity": "text",
          "permanentPincode": "text",
          "correspondenceCity": "text",
          "correspondencePincode": "text",
          "correspondenceAddress": "text",
          "active": true,
          "dob": "2025-02-22",
          "pwdExpiryDate": "2025-02-22",
          "locale": "text",
          "signature": "text",
          "accountLocked": true,
          "fatherOrHusbandName": "text",
          "identificationMark": "text",
          "photo": "text",
          "createdBy": 1,
          "createdDate": "2025-02-22",
          "lastModifiedBy": 1,
          "lastModifiedDate": "2025-02-22",
          "otpReference": "text",
          "tenantId": "text",
          "roles": [
            {
              "id": 1,
              "name": "text",
              "code": "text",
              "description": "text",
              "createdBy": 1,
              "createdDate": "2025-02-22",
              "lastModifiedBy": 1,
              "lastModifiedDate": "2025-02-22",
              "tenantId": "text"
            }
          ],
          "gender": [
            "MALE"
          ],
          "type": [
            "EMPLOYEE"
          ],
          "bloodGroup": [
            "A+"
          ]
        }
      ],
      "nextActions": [
        "text"
      ]
    }
  ]
}

Application(s) Retrived Successfully

Get the count of applications satisfying the given criteria

1. Returns the total number of application in the system based on the criteria given
2. Primarily used to shoe total count in inbox

post

/_count

Query parameters

idsinteger · int64[]

unique identifier of trade licence

businessServicestring · min: 2 · max: 64

Unique application number for a trade license application.

businessIdsinteger · int64[]

The list of businessIds

assigneestring · min: 2 · max: 64

The unique Old license number for a Trade license.

historyboolean

Boolean flag to return history of the workflow

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-wf/_count'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProcessInstances": [
    {
      "id": "text",
      "tenantId": "text",
      "businessService": "text",
      "businessId": "text",
      "action": "text",
      "state": "text",
      "comment": "text",
      "assigner": {
        "id": 1,
        "userName": "text",
        "password": "super-secret",
        "salutation": "text",
        "name": "text",
        "mobileNumber": "text",
        "emailId": "text",
        "altContactNumber": "text",
        "pan": "text",
        "aadhaarNumber": "text",
        "permanentAddress": "text",
        "permanentCity": "text",
        "permanentPincode": "text",
        "correspondenceCity": "text",
        "correspondencePincode": "text",
        "correspondenceAddress": "text",
        "active": true,
        "dob": "2025-02-22",
        "pwdExpiryDate": "2025-02-22",
        "locale": "text",
        "signature": "text",
        "accountLocked": true,
        "fatherOrHusbandName": "text",
        "identificationMark": "text",
        "photo": "text",
        "createdBy": 1,
        "createdDate": "2025-02-22",
        "lastModifiedBy": 1,
        "lastModifiedDate": "2025-02-22",
        "otpReference": "text",
        "tenantId": "text",
        "roles": [
          {
            "id": 1,
            "name": "text",
            "code": "text",
            "description": "text",
            "createdBy": 1,
            "createdDate": "2025-02-22",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-02-22",
            "tenantId": "text"
          }
        ],
        "gender": [
          "MALE"
        ],
        "type": [
          "EMPLOYEE"
        ],
        "bloodGroup": [
          "A+"
        ]
      },
      "sla": 1,
      "currentStatus": "text",
      "previousStatus": "text",
      "entity": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "documents": [
        {
          "id": "text",
          "tenantId": "text",
          "documentType": "text",
          "fileStoreId": "text",
          "documentUid": "text",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "assignes": [
        {
          "id": 1,
          "userName": "text",
          "password": "super-secret",
          "salutation": "text",
          "name": "text",
          "mobileNumber": "text",
          "emailId": "text",
          "altContactNumber": "text",
          "pan": "text",
          "aadhaarNumber": "text",
          "permanentAddress": "text",
          "permanentCity": "text",
          "permanentPincode": "text",
          "correspondenceCity": "text",
          "correspondencePincode": "text",
          "correspondenceAddress": "text",
          "active": true,
          "dob": "2025-02-22",
          "pwdExpiryDate": "2025-02-22",
          "locale": "text",
          "signature": "text",
          "accountLocked": true,
          "fatherOrHusbandName": "text",
          "identificationMark": "text",
          "photo": "text",
          "createdBy": 1,
          "createdDate": "2025-02-22",
          "lastModifiedBy": 1,
          "lastModifiedDate": "2025-02-22",
          "otpReference": "text",
          "tenantId": "text",
          "roles": [
            {
              "id": 1,
              "name": "text",
              "code": "text",
              "description": "text",
              "createdBy": 1,
              "createdDate": "2025-02-22",
              "lastModifiedBy": 1,
              "lastModifiedDate": "2025-02-22",
              "tenantId": "text"
            }
          ],
          "gender": [
            "MALE"
          ],
          "type": [
            "EMPLOYEE"
          ],
          "bloodGroup": [
            "A+"
          ]
        }
      ],
      "nextActions": [
        "text"
      ]
    }
  ]
}

Trade License(s) Retrived Successfully

Create new BuinessService.

To create new workflow configuration(BuinessService) in the system. API supports bulk creation with max limit as defined in the BuinessService Request. Please note that either whole batch succeeds or fails, there's no partial batch success. To create one BuinessService, please pass array with one BuinessService object.

Following Conditions are applied -

1. All actions have valid next state i.e next state should be present in the system
2. uuids will be auto generated and assigned to all sub objects
3. For end states isTerminateState should be true

post

/businessservice/_create

Body

RequestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

BusinessServiceobject[] · min: 1 · max: 100

Used for search result and create only

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-wf/businessservice/_create' \
  --header 'Content-Type: application/json'

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BusinessService": [
    {
      "tenantId": "text",
      "uuid": "text",
      "businessService": "text",
      "getUri": "text",
      "postUri": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "states": [
        {
          "uuid": "text",
          "tenantId": "text",
          "businessServiceId": "text",
          "state": "text",
          "applicationStatus": "text",
          "docUploadRequired": true,
          "isStartState": true,
          "isTerminateState": true,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "actions": [
            {
              "uuid": "text",
              "tenantId": "text",
              "stateId": "text",
              "action": "text",
              "nextStateId": "text",
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text",
                "createdTime": 1,
                "lastModifiedTime": 1
              },
              "roles": [
                "text"
              ]
            }
          ]
        }
      ]
    }
  ]
}

ReponseInfo withBusinessService(s) created successfully

Updates a existing BuinessService.

Can be used only to add new state or action in the workflow. Can update any existing field. Removing of any state is not allowed as applications in that state will be in invalid state

Following Conditions are applied -

1. can add states and actions
2. can update roles in action, SLA etc.

post

/businessservice/_update

Body

RequestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

BusinessServiceobject[] · min: 1 · max: 100

Used for search result and create only

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-wf/businessservice/_update' \
  --header 'Content-Type: application/json'

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BusinessService": [
    {
      "tenantId": "text",
      "uuid": "text",
      "businessService": "text",
      "getUri": "text",
      "postUri": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "states": [
        {
          "uuid": "text",
          "tenantId": "text",
          "businessServiceId": "text",
          "state": "text",
          "applicationStatus": "text",
          "docUploadRequired": true,
          "isStartState": true,
          "isTerminateState": true,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "actions": [
            {
              "uuid": "text",
              "tenantId": "text",
              "stateId": "text",
              "action": "text",
              "nextStateId": "text",
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text",
                "createdTime": 1,
                "lastModifiedTime": 1
              },
              "roles": [
                "text"
              ]
            }
          ]
        }
      ]
    }
  ]
}

ReponseInfo withBusinessService(s) created successfully

Get the list of BusinessServices defined in the system.

1. Search and get BusinessServices(s) based on defined search criteria.
2. In case multiple parameters are passed BusinessService(s) will be searched as an AND combination of all the parameters.

post

/businessservice/_search

Query parameters

businessServicesinteger · int64[]

BusinessService code of the businessService

tenantIdstring · min: 2 · max: 64

TenantId of the ULB.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-wf/businessservice/_search'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BusinessService": [
    {
      "tenantId": "text",
      "uuid": "text",
      "businessService": "text",
      "getUri": "text",
      "postUri": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "states": [
        {
          "uuid": "text",
          "tenantId": "text",
          "businessServiceId": "text",
          "state": "text",
          "applicationStatus": "text",
          "docUploadRequired": true,
          "isStartState": true,
          "isTerminateState": true,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "actions": [
            {
              "uuid": "text",
              "tenantId": "text",
              "stateId": "text",
              "action": "text",
              "nextStateId": "text",
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text",
                "createdTime": 1,
                "lastModifiedTime": 1
              },
              "roles": [
                "text"
              ]
            }
          ]
        }
      ]
    }
  ]
}

Trade License(s) Retrived Successfully