Workflow
Workflow Engine APIs
APIs to create new, search, initiate workflows and transition states.
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
*/*
400
Workflow(s) creation failed
*/*
post
POST /egov-wf/process/_transition HTTP/1.1
Host:
Content-Type: */*
Accept: */*
Content-Length: 2700
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
}
},
"ProcessInstances": [
{
"tenantId": "text",
"businessService": "text",
"businessId": "text",
"action": "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": "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-07-12",
"locale": "text",
"type": "text",
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": "text",
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"otpReference": "text",
"tenantId": "text"
},
"assignes": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": "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-07-12",
"locale": "text",
"type": "text",
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": "text",
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"otpReference": "text",
"tenantId": "text"
}
],
"sla": 1,
"currentStatus": "text",
"previousStatus": "text",
"entity": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}{
"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": "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-07-12",
"pwdExpiryDate": "2025-07-12",
"locale": "text",
"type": "text",
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": "text",
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"otpReference": "text",
"tenantId": "text"
},
"assignes": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": "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-07-12",
"pwdExpiryDate": "2025-07-12",
"locale": "text",
"type": "text",
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": "text",
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"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.
Query parameters
tenantIdstring · varcharRequired
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
Body
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.
apiIdstring · max: 128Required
unique API ID
verstring · max: 32Required
API version - for HTTP based request this will be same as used in path
tsinteger · int64Required
time in epoch
actionstring · max: 32Required
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
didstring · max: 1024Optional
Device ID from which the API is called
keystring · max: 256Optional
API key (API key provided to the caller in case of server to server communication)
msgIdstring · max: 256Required
Unique request message id from the caller
requesterIdstring · max: 256Optional
UserId of the user calling
authTokenstringOptional
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
correlationIdstringRead-onlyOptional
Responses
200
Application(s) Retrived Successfully
*/*
400
Invalid input.
*/*
post
POST /egov-wf/process/_search?tenantId=text HTTP/1.1
Host:
Content-Type: */*
Accept: */*
Content-Length: 430
{
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
}
}{
"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": "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-07-12",
"pwdExpiryDate": "2025-07-12",
"locale": "text",
"type": "text",
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": "text",
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"otpReference": "text",
"tenantId": "text"
},
"assignes": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": "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-07-12",
"pwdExpiryDate": "2025-07-12",
"locale": "text",
"type": "text",
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": "text",
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"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
Query parameters
tenantIdstring · varcharRequired
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
Body
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.
apiIdstring · max: 128Required
unique API ID
verstring · max: 32Required
API version - for HTTP based request this will be same as used in path
tsinteger · int64Required
time in epoch
actionstring · max: 32Required
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
didstring · max: 1024Optional
Device ID from which the API is called
keystring · max: 256Optional
API key (API key provided to the caller in case of server to server communication)
msgIdstring · max: 256Required
Unique request message id from the caller
requesterIdstring · max: 256Optional
UserId of the user calling
authTokenstringOptional
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
correlationIdstringRead-onlyOptional
Responses
200
Trade License(s) Retrived Successfully
*/*
400
Invalid input.
*/*
post
POST /egov-wf/process/_count?tenantId=text HTTP/1.1
Host:
Content-Type: */*
Accept: */*
Content-Length: 430
{
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
}
}{
"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": "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-07-12",
"pwdExpiryDate": "2025-07-12",
"locale": "text",
"type": "text",
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": "text",
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"otpReference": "text",
"tenantId": "text"
},
"assignes": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": "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-07-12",
"pwdExpiryDate": "2025-07-12",
"locale": "text",
"type": "text",
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": "text",
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"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.
Query parameters
tenantIdstring · varcharRequired
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
Body
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.
apiIdstring · max: 128Required
unique API ID
verstring · max: 32Required
API version - for HTTP based request this will be same as used in path
tsinteger · int64Required
time in epoch
actionstring · max: 32Required
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
didstring · max: 1024Optional
Device ID from which the API is called
keystring · max: 256Optional
API key (API key provided to the caller in case of server to server communication)
msgIdstring · max: 256Required
Unique request message id from the caller
requesterIdstring · max: 256Optional
UserId of the user calling
authTokenstringOptional
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
correlationIdstringRead-onlyOptional
Responses
200
Application(s) Retrived Successfully
*/*
400
Invalid input.
*/*
post
POST /egov-wf/process/_nearingslacount?tenantId=text HTTP/1.1
Host:
Content-Type: */*
Accept: */*
Content-Length: 430
{
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
}
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Count": 1,
"ProcessInstances": [
{
"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": "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-07-12",
"pwdExpiryDate": "2025-07-12",
"locale": "text",
"type": "text",
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": "text",
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"otpReference": "text",
"tenantId": "text"
},
"assignes": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": "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-07-12",
"pwdExpiryDate": "2025-07-12",
"locale": "text",
"type": "text",
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": "text",
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"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.
Query parameters
tenantIdstring · varcharRequired
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
Body
Responses
200
Application(s) Retrived Successfully
*/*
400
Invalid input.
*/*
post
POST /egov-wf/process/_statuscount?tenantId=text HTTP/1.1
Host:
Content-Type: */*
Accept: */*
Content-Length: 673
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
}
},
"ProcessInstanceSearchCriteria": {
"tenantId": "text",
"status": "text",
"businessIds": "text",
"assignee": "text",
"ids": [
"text"
],
"history": true,
"fromDate": 1,
"toDate": 1,
"offset": 1,
"limit": 1,
"businessService": "text",
"moduleName": "text"
}
}{
"body": {},
"result": [
"text"
],
"statusCode": "ACCEPTED",
"statusCountValue": 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.
Query parameters
tenantIdstring · varcharRequired
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
Body
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.
apiIdstring · max: 128Required
unique API ID
verstring · max: 32Required
API version - for HTTP based request this will be same as used in path
tsinteger · int64Required
time in epoch
actionstring · max: 32Required
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
didstring · max: 1024Optional
Device ID from which the API is called
keystring · max: 256Optional
API key (API key provided to the caller in case of server to server communication)
msgIdstring · max: 256Required
Unique request message id from the caller
requesterIdstring · max: 256Optional
UserId of the user calling
authTokenstringOptional
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
correlationIdstringRead-onlyOptional
Responses
200
Application(s) Retrived Successfully
*/*
400
Invalid input.
*/*
post
POST /egov-wf/process/escalate/_search?tenantId=text HTTP/1.1
Host:
Content-Type: */*
Accept: */*
Content-Length: 430
{
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
}
}{
"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": "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-07-12",
"pwdExpiryDate": "2025-07-12",
"locale": "text",
"type": "text",
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": "text",
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"otpReference": "text",
"tenantId": "text"
},
"assignes": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": "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-07-12",
"pwdExpiryDate": "2025-07-12",
"locale": "text",
"type": "text",
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": "text",
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"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.
Path parameters
businessServicestring · min: 2 · max: 64Required
Name of the workflow confguration.
Query parameters
tenantIdstring · varcharRequired
Unique id for a tenant.
idsinteger · int64[] · max: 50Optional
unique identifier of Application
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
Body
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.
apiIdstring · max: 128Required
unique API ID
verstring · max: 32Required
API version - for HTTP based request this will be same as used in path
tsinteger · int64Required
time in epoch
actionstring · max: 32Required
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
didstring · max: 1024Optional
Device ID from which the API is called
keystring · max: 256Optional
API key (API key provided to the caller in case of server to server communication)
msgIdstring · max: 256Required
Unique request message id from the caller
requesterIdstring · max: 256Optional
UserId of the user calling
authTokenstringOptional
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
correlationIdstringRead-onlyOptional
Responses
200
Application(s) Retrived Successfully
*/*
400
Invalid input.
*/*
post
POST /egov-wf/auto/{businessService}/_escalate?tenantId=text HTTP/1.1
Host:
Content-Type: */*
Accept: */*
Content-Length: 430
{
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
}
}{
"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": "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-07-12",
"pwdExpiryDate": "2025-07-12",
"locale": "text",
"type": "text",
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": "text",
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"otpReference": "text",
"tenantId": "text"
},
"assignes": [
{
"id": 1,
"userName": "text",
"password": "password",
"salutation": "text",
"name": "text",
"gender": "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-07-12",
"pwdExpiryDate": "2025-07-12",
"locale": "text",
"type": "text",
"signature": "text",
"accountLocked": true,
"roles": [
{
"id": 1,
"name": "text",
"code": "text",
"description": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"tenantId": "text"
}
],
"fatherOrHusbandName": "text",
"bloodGroup": "text",
"identificationMark": "text",
"photo": "text",
"createdBy": 1,
"createdDate": "2025-07-12",
"lastModifiedBy": 1,
"lastModifiedDate": "2025-07-12",
"otpReference": "text",
"tenantId": "text"
}
],
"nextActions": [
"text"
],
"sla": 1,
"currentStatus": "text",
"previousStatus": "text",
"entity": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}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
*/*
400
BusinessService(s) creation failed
*/*
post
POST /egov-wf/businessservice/v2/_create HTTP/1.1
Host:
Content-Type: */*
Accept: */*
Content-Length: 1149
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "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"
],
"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
}
}
]
}{
"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
*/*
400
BusinessService(s) creation failed
*/*
post
POST /egov-wf/businessservice/v2/_update HTTP/1.1
Host:
Content-Type: */*
Accept: */*
Content-Length: 1149
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "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"
],
"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
}
}
]
}{
"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.
Query parameters
businessServicesinteger · int64[] · max: 50Optional
BusinessService code of the businessService
tenantIdstring · varcharRequired
Unique id for a tenant.
Body
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.
apiIdstring · max: 128Required
unique API ID
verstring · max: 32Required
API version - for HTTP based request this will be same as used in path
tsinteger · int64Required
time in epoch
actionstring · max: 32Required
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
didstring · max: 1024Optional
Device ID from which the API is called
keystring · max: 256Optional
API key (API key provided to the caller in case of server to server communication)
msgIdstring · max: 256Required
Unique request message id from the caller
requesterIdstring · max: 256Optional
UserId of the user calling
authTokenstringOptional
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
correlationIdstringRead-onlyOptional
Responses
200
Trade License(s) Retrived Successfully
*/*
400
Invalid input.
*/*
post
POST /egov-wf/businessservice/v2/_search?tenantId=text HTTP/1.1
Host:
Content-Type: */*
Accept: */*
Content-Length: 430
{
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "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
}
}
]
}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
*/*
400
BusinessService(s) creation failed
*/*
post
POST /egov-wf/businessservice/_create HTTP/1.1
Host:
Content-Type: */*
Accept: */*
Content-Length: 1149
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "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"
],
"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
}
}
]
}{
"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
*/*
400
BusinessService(s) creation failed
*/*
post
POST /egov-wf/businessservice/_update HTTP/1.1
Host:
Content-Type: */*
Accept: */*
Content-Length: 1149
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "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"
],
"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
}
}
]
}{
"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.
Query parameters
businessServicesinteger · int64[] · max: 50Optional
BusinessService code of the businessService
tenantIdstring · varcharRequired
Unique id for a tenant.
Body
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.
apiIdstring · max: 128Required
unique API ID
verstring · max: 32Required
API version - for HTTP based request this will be same as used in path
tsinteger · int64Required
time in epoch
actionstring · max: 32Required
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
didstring · max: 1024Optional
Device ID from which the API is called
keystring · max: 256Optional
API key (API key provided to the caller in case of server to server communication)
msgIdstring · max: 256Required
Unique request message id from the caller
requesterIdstring · max: 256Optional
UserId of the user calling
authTokenstringOptional
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
correlationIdstringRead-onlyOptional
Responses
200
Trade License(s) Retrived Successfully
*/*
400
Invalid input.
*/*
post
POST /egov-wf/businessservice/_search?tenantId=text HTTP/1.1
Host:
Content-Type: */*
Accept: */*
Content-Length: 430
{
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "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
}
}
]
}Last updated
Was this helpful?