Workflow Service
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 -
- All actions have valid next state i.e next state should be present in the system
- uuids will be auto generated and assigned to all sub objects
- For end states isTerminateState should be true
Body
Contract class to receive request. Array of TradeLicense items are used in case of create, whereas single TradeLicense item is used for update
Responses
201
ReponseInfo withBusinessService(s) created successfully
application/json
400
BusinessService(s) creation failed
application/json
post
POST /egov-wf/businessservice/_create HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 561
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"BusinessService": [
{
"tenantId": "text",
"uuid": "text",
"businessService": "text",
"getUri": "text",
"postUri": "text",
"states": [
{
"uuid": "text",
"tenantId": "text",
"businessServiceId": "text",
"state": "text",
"applicationStatus": "text",
"docUploadRequired": true,
"isStartState": true,
"isTerminateState": true,
"actions": [
{
"uuid": "text",
"tenantId": "text",
"stateId": "text",
"action": "text",
"nextStateId": "text",
"roles": [
"text"
]
}
]
}
]
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"BusinessService": [
{
"tenantId": "text",
"uuid": "text",
"businessService": "text",
"getUri": "text",
"postUri": "text",
"states": [
{
"uuid": "text",
"tenantId": "text",
"businessServiceId": "text",
"state": "text",
"applicationStatus": "text",
"docUploadRequired": true,
"isStartState": true,
"isTerminateState": true,
"actions": [
{
"uuid": "text",
"tenantId": "text",
"stateId": "text",
"action": "text",
"nextStateId": "text",
"roles": [
"text"
],
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}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 -
- can add states and actions
- can update roles in action, SLA etc.
Body
Contract class to receive request. Array of TradeLicense items are used in case of create, whereas single TradeLicense item is used for update
Responses
201
ReponseInfo withBusinessService(s) created successfully
application/json
400
BusinessService(s) creation failed
application/json
post
POST /egov-wf/businessservice/_update HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 561
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"BusinessService": [
{
"tenantId": "text",
"uuid": "text",
"businessService": "text",
"getUri": "text",
"postUri": "text",
"states": [
{
"uuid": "text",
"tenantId": "text",
"businessServiceId": "text",
"state": "text",
"applicationStatus": "text",
"docUploadRequired": true,
"isStartState": true,
"isTerminateState": true,
"actions": [
{
"uuid": "text",
"tenantId": "text",
"stateId": "text",
"action": "text",
"nextStateId": "text",
"roles": [
"text"
]
}
]
}
]
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"BusinessService": [
{
"tenantId": "text",
"uuid": "text",
"businessService": "text",
"getUri": "text",
"postUri": "text",
"states": [
{
"uuid": "text",
"tenantId": "text",
"businessServiceId": "text",
"state": "text",
"applicationStatus": "text",
"docUploadRequired": true,
"isStartState": true,
"isTerminateState": true,
"actions": [
{
"uuid": "text",
"tenantId": "text",
"stateId": "text",
"action": "text",
"nextStateId": "text",
"roles": [
"text"
],
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}- Search and get BusinessServices(s) based on defined search criteria.
- In case multiple parameters are passed BusinessService(s) will be searched as an AND combination of all the parameters.
body
requestInfoanyOptional
Parameter to carry Request metadata in the request body
Query parameters
tenantIdanyRequired
Unique id for a tenant.
businessServicesinteger · int64[] · max: 50Optional
BusinessService code of the businessService
Responses
200
Trade License(s) Retrived Successfully
application/json
400
Invalid input.
application/json
post
POST /egov-wf/businessservice/_search?tenantId=null HTTP/1.1
Host:
Accept: */*
{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"BusinessService": [
{
"tenantId": "text",
"uuid": "text",
"businessService": "text",
"getUri": "text",
"postUri": "text",
"states": [
{
"uuid": "text",
"tenantId": "text",
"businessServiceId": "text",
"state": "text",
"applicationStatus": "text",
"docUploadRequired": true,
"isStartState": true,
"isTerminateState": true,
"actions": [
{
"uuid": "text",
"tenantId": "text",
"stateId": "text",
"action": "text",
"nextStateId": "text",
"roles": [
"text"
],
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}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 -
- Valid action is send according to workflow configuration defined
- supportDocuments to perform workflow action will created. In case of not attaching the Mandatory Supported Documents creation of workflow Fails.
- Application will move to next state if valid action is passes.
Body
Contract class to receive request. Array of TradeLicense items are used in case of create, whereas single TradeLicense item is used for update
Responses
201
ReponseInfo with Workflow(s) created successfully
application/json
400
Workflow(s) creation failed
application/json
post
POST /egov-wf/process/_transition HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 1336
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"ProcessInstances": [
{
"tenantId": "text",
"businessService": "text",
"businessId": "text",
"action": "text",
"comment": "text",
"documents": [
{
"id": "text",
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text"
}
],
"assignes": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"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-06-25",
"locale": "text",
"type": [
"EMPLOYEE"
],
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-06-25",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-06-25",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": [
"A+"
],
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-06-25",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-06-25",
"otpReference": "text",
"tenantId": "text"
}
],
"sla": 1,
"currentStatus": "text",
"previousStatus": "text",
"entity": {}
}
]
}{
"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",
"documents": [
{
"id": "text",
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"assigner": {
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"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-06-25",
"pwdExpiryDate": "2025-06-25",
"locale": "text",
"type": [
"EMPLOYEE"
],
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-06-25",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-06-25",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": [
"A+"
],
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-06-25",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-06-25",
"otpReference": "text",
"tenantId": "text"
},
"assignes": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"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-06-25",
"pwdExpiryDate": "2025-06-25",
"locale": "text",
"type": [
"EMPLOYEE"
],
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-06-25",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-06-25",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": [
"A+"
],
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-06-25",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-06-25",
"otpReference": "text",
"tenantId": "text"
}
],
"nextActions": [
"text"
],
"sla": 1,
"currentStatus": "text",
"previousStatus": "text",
"entity": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}- Search and get Application(s) based on defined search criteria.
- In case multiple parameters are passed Application(s) will be searched as an AND combination of all the parameters.
body
requestInfoanyOptional
Parameter to carry Request metadata in the request body
Query parameters
tenantIdanyRequired
Unique id for a tenant.
idsinteger · int64[] · max: 50Optional
unique identifier of Application
businessServicestring · min: 2 · max: 64Optional
Name of the workflow confguration.
moduleNamestring · min: 2 · max: 64Optional
Module name to which workflow application belongs
businessIdsstring[] · max: 50Optional
The list of businessIds
assigneestring · min: 2 · max: 64Optional
The unique Old license number for a Application.
historybooleanOptional
Boolean flag to return history of the workflow
limitintegerOptional
Number of records to be returned
offsetintegerOptional
Starting offset for returning search response
Responses
200
Application(s) Retrived Successfully
application/json
400
Invalid input.
application/json
post
POST /egov-wf/_search?tenantId=null HTTP/1.1
Host:
Accept: */*
{
"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",
"documents": [
{
"id": "text",
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"assigner": {
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"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-06-25",
"pwdExpiryDate": "2025-06-25",
"locale": "text",
"type": [
"EMPLOYEE"
],
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-06-25",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-06-25",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": [
"A+"
],
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-06-25",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-06-25",
"otpReference": "text",
"tenantId": "text"
},
"assignes": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"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-06-25",
"pwdExpiryDate": "2025-06-25",
"locale": "text",
"type": [
"EMPLOYEE"
],
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-06-25",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-06-25",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": [
"A+"
],
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-06-25",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-06-25",
"otpReference": "text",
"tenantId": "text"
}
],
"nextActions": [
"text"
],
"sla": 1,
"currentStatus": "text",
"previousStatus": "text",
"entity": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}- Returns the total number of application in the system based on the criteria given
- Primarily used to shoe total count in inbox
body
requestInfoanyOptional
Parameter to carry Request metadata in the request body
Query parameters
tenantIdanyRequired
Unique id for a tenant.
idsinteger · int64[] · max: 50Optional
unique identifier of trade licence
businessServicestring · min: 2 · max: 64Optional
Unique application number for a trade license application.
businessIdsinteger · int64[] · max: 50Optional
The list of businessIds
assigneestring · min: 2 · max: 64Optional
The unique Old license number for a Trade license.
historybooleanOptional
Boolean flag to return history of the workflow
Responses
200
Trade License(s) Retrived Successfully
application/json
400
Invalid input.
application/json
post
POST /egov-wf/_count?tenantId=null HTTP/1.1
Host:
Accept: */*
{
"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",
"documents": [
{
"id": "text",
"tenantId": "text",
"documentType": "text",
"fileStoreId": "text",
"documentUid": "text",
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"assigner": {
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"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-06-25",
"pwdExpiryDate": "2025-06-25",
"locale": "text",
"type": [
"EMPLOYEE"
],
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-06-25",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-06-25",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": [
"A+"
],
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-06-25",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-06-25",
"otpReference": "text",
"tenantId": "text"
},
"assignes": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": [
"MALE"
],
"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-06-25",
"pwdExpiryDate": "2025-06-25",
"locale": "text",
"type": [
"EMPLOYEE"
],
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-06-25",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-06-25",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": [
"A+"
],
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-06-25",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-06-25",
"otpReference": "text",
"tenantId": "text"
}
],
"nextActions": [
"text"
],
"sla": 1,
"currentStatus": "text",
"previousStatus": "text",
"entity": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}Last updated
Was this helpful?