Workflow

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/egov-wf/process/_transition

Body

*/*

Details for the new Workflow(s) + RequestInfo meta data.

RequestInfoRequestInfo (object)

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.

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

Response

201400

ReponseInfo with Workflow(s) created successfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

Request

JavaScriptCurlPython

const response = await fetch('/egov-wf/process/_transition', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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"
          }
        }
      ],
      "assigner": {
        "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": false,
        "dob": "2024-11-07",
        "pwdExpiryDate": "2024-11-07",
        "locale": "text",
        "type": "text",
        "signature": "text",
        "accountLocked": false,
        "roles": [
          {
            "name": "text",
            "code": "text",
            "description": "text",
            "createdDate": "2024-11-07",
            "lastModifiedDate": "2024-11-07",
            "tenantId": "text"
          }
        ],
        "fatherOrHusbandName": "text",
        "bloodGroup": "text",
        "identificationMark": "text",
        "photo": "text",
        "createdDate": "2024-11-07",
        "lastModifiedDate": "2024-11-07",
        "otpReference": "text",
        "tenantId": "text"
      },
      "assignes": [
        {
          "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": false,
          "dob": "2024-11-07",
          "pwdExpiryDate": "2024-11-07",
          "locale": "text",
          "type": "text",
          "signature": "text",
          "accountLocked": false,
          "roles": [
            {
              "name": "text",
              "code": "text",
              "description": "text",
              "createdDate": "2024-11-07",
              "lastModifiedDate": "2024-11-07",
              "tenantId": "text"
            }
          ],
          "fatherOrHusbandName": "text",
          "bloodGroup": "text",
          "identificationMark": "text",
          "photo": "text",
          "createdDate": "2024-11-07",
          "lastModifiedDate": "2024-11-07",
          "otpReference": "text",
          "tenantId": "text"
        }
      ],
      "nextActions": [
        "text"
      ],
      "currentStatus": "text",
      "previousStatus": "text",
      "entity": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

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/egov-wf/process/_search

Query parameters

Body

*/*

Parameter to carry Request metadata in the request body

apiId*string

unique API ID

ver*string

API version - for HTTP based request this will be same as used in path

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoUserInfo (object)

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstring

Response

200400

Application(s) Retrived Successfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

Request

JavaScriptCurlPython

const response = await fetch('/egov-wf/process/_search?tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "msgId": "text",
      "ver": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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"
          }
        }
      ],
      "assigner": {
        "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": false,
        "dob": "2024-11-07",
        "pwdExpiryDate": "2024-11-07",
        "locale": "text",
        "type": "text",
        "signature": "text",
        "accountLocked": false,
        "roles": [
          {
            "name": "text",
            "code": "text",
            "description": "text",
            "createdDate": "2024-11-07",
            "lastModifiedDate": "2024-11-07",
            "tenantId": "text"
          }
        ],
        "fatherOrHusbandName": "text",
        "bloodGroup": "text",
        "identificationMark": "text",
        "photo": "text",
        "createdDate": "2024-11-07",
        "lastModifiedDate": "2024-11-07",
        "otpReference": "text",
        "tenantId": "text"
      },
      "assignes": [
        {
          "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": false,
          "dob": "2024-11-07",
          "pwdExpiryDate": "2024-11-07",
          "locale": "text",
          "type": "text",
          "signature": "text",
          "accountLocked": false,
          "roles": [
            {
              "name": "text",
              "code": "text",
              "description": "text",
              "createdDate": "2024-11-07",
              "lastModifiedDate": "2024-11-07",
              "tenantId": "text"
            }
          ],
          "fatherOrHusbandName": "text",
          "bloodGroup": "text",
          "identificationMark": "text",
          "photo": "text",
          "createdDate": "2024-11-07",
          "lastModifiedDate": "2024-11-07",
          "otpReference": "text",
          "tenantId": "text"
        }
      ],
      "nextActions": [
        "text"
      ],
      "currentStatus": "text",
      "previousStatus": "text",
      "entity": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

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/egov-wf/process/_count

Query parameters

Body

*/*

Parameter to carry Request metadata in the request body

apiId*string

unique API ID

ver*string

API version - for HTTP based request this will be same as used in path

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoUserInfo (object)

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstring

Response

200400

Trade License(s) Retrived Successfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

Request

JavaScriptCurlPython

const response = await fetch('/egov-wf/process/_count?tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "msgId": "text",
      "ver": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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"
          }
        }
      ],
      "assigner": {
        "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": false,
        "dob": "2024-11-07",
        "pwdExpiryDate": "2024-11-07",
        "locale": "text",
        "type": "text",
        "signature": "text",
        "accountLocked": false,
        "roles": [
          {
            "name": "text",
            "code": "text",
            "description": "text",
            "createdDate": "2024-11-07",
            "lastModifiedDate": "2024-11-07",
            "tenantId": "text"
          }
        ],
        "fatherOrHusbandName": "text",
        "bloodGroup": "text",
        "identificationMark": "text",
        "photo": "text",
        "createdDate": "2024-11-07",
        "lastModifiedDate": "2024-11-07",
        "otpReference": "text",
        "tenantId": "text"
      },
      "assignes": [
        {
          "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": false,
          "dob": "2024-11-07",
          "pwdExpiryDate": "2024-11-07",
          "locale": "text",
          "type": "text",
          "signature": "text",
          "accountLocked": false,
          "roles": [
            {
              "name": "text",
              "code": "text",
              "description": "text",
              "createdDate": "2024-11-07",
              "lastModifiedDate": "2024-11-07",
              "tenantId": "text"
            }
          ],
          "fatherOrHusbandName": "text",
          "bloodGroup": "text",
          "identificationMark": "text",
          "photo": "text",
          "createdDate": "2024-11-07",
          "lastModifiedDate": "2024-11-07",
          "otpReference": "text",
          "tenantId": "text"
        }
      ],
      "nextActions": [
        "text"
      ],
      "currentStatus": "text",
      "previousStatus": "text",
      "entity": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Get the nearing sla count 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/egov-wf/process/_nearingslacount

Query parameters

Body

*/*

Parameter to carry Request metadata in the request body

apiId*string

unique API ID

ver*string

API version - for HTTP based request this will be same as used in path

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoUserInfo (object)

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstring

Response

200400

Application(s) Retrived Successfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Countinteger

ProcessInstancesarray of ProcessIntanceResponse (object)

Used for search result and create only

Request

JavaScriptCurlPython

const response = await fetch('/egov-wf/process/_nearingslacount?tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "msgId": "text",
      "ver": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProcessInstances": [
    {
      "ResponseInfo": {
        "apiId": "text",
        "ver": "text",
        "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"
              }
            }
          ],
          "assigner": {
            "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": false,
            "dob": "2024-11-07",
            "pwdExpiryDate": "2024-11-07",
            "locale": "text",
            "type": "text",
            "signature": "text",
            "accountLocked": false,
            "roles": [
              {
                "name": "text",
                "code": "text",
                "description": "text",
                "createdDate": "2024-11-07",
                "lastModifiedDate": "2024-11-07",
                "tenantId": "text"
              }
            ],
            "fatherOrHusbandName": "text",
            "bloodGroup": "text",
            "identificationMark": "text",
            "photo": "text",
            "createdDate": "2024-11-07",
            "lastModifiedDate": "2024-11-07",
            "otpReference": "text",
            "tenantId": "text"
          },
          "assignes": [
            {
              "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": false,
              "dob": "2024-11-07",
              "pwdExpiryDate": "2024-11-07",
              "locale": "text",
              "type": "text",
              "signature": "text",
              "accountLocked": false,
              "roles": [
                {
                  "name": "text",
                  "code": "text",
                  "description": "text",
                  "createdDate": "2024-11-07",
                  "lastModifiedDate": "2024-11-07",
                  "tenantId": "text"
                }
              ],
              "fatherOrHusbandName": "text",
              "bloodGroup": "text",
              "identificationMark": "text",
              "photo": "text",
              "createdDate": "2024-11-07",
              "lastModifiedDate": "2024-11-07",
              "otpReference": "text",
              "tenantId": "text"
            }
          ],
          "nextActions": [
            "text"
          ],
          "currentStatus": "text",
          "previousStatus": "text",
          "entity": {},
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      ]
    }
  ]
}

Get the list of status count 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/egov-wf/process/_statuscount

Query parameters

Body

*/*

Parameter to carry Request metadata in the request body

RequestInfoRequestInfo (object)

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.

ProcessInstanceSearchCriteriaProcessInstanceSearchCriteria (object)

Response

200400

Application(s) Retrived Successfully

Body

*/*

bodyobject

resultarray of string

statusCodeenum

ACCEPTEDALREADY_REPORTEDBAD_GATEWAYBAD_REQUESTBANDWIDTH_LIMIT_EXCEEDEDCHECKPOINTCONFLICTCONTINUECREATEDDESTINATION_LOCKEDEXPECTATION_FAILEDFAILED_DEPENDENCYFORBIDDENFOUNDGATEWAY_TIMEOUTGONEHTTP_VERSION_NOT_SUPPORTEDIM_USEDINSUFFICIENT_SPACE_ON_RESOURCEINSUFFICIENT_STORAGEINTERNAL_SERVER_ERRORI_AM_A_TEAPOTLENGTH_REQUIREDLOCKEDLOOP_DETECTEDMETHOD_FAILUREMETHOD_NOT_ALLOWEDMOVED_PERMANENTLYMOVED_TEMPORARILYMULTIPLE_CHOICESMULTI_STATUSNETWORK_AUTHENTICATION_REQUIREDNON_AUTHORITATIVE_INFORMATIONNOT_ACCEPTABLENOT_EXTENDEDNOT_FOUNDNOT_IMPLEMENTEDNOT_MODIFIEDNO_CONTENTOKPARTIAL_CONTENTPAYLOAD_TOO_LARGEPAYMENT_REQUIREDPERMANENT_REDIRECTPRECONDITION_FAILEDPRECONDITION_REQUIREDPROCESSINGPROXY_AUTHENTICATION_REQUIREDREQUESTED_RANGE_NOT_SATISFIABLEREQUEST_ENTITY_TOO_LARGEREQUEST_HEADER_FIELDS_TOO_LARGEREQUEST_TIMEOUTREQUEST_URI_TOO_LONGRESET_CONTENTSEE_OTHERSERVICE_UNAVAILABLESWITCHING_PROTOCOLSTEMPORARY_REDIRECTTOO_EARLYTOO_MANY_REQUESTSUNAUTHORIZEDUNAVAILABLE_FOR_LEGAL_REASONSUNPROCESSABLE_ENTITYUNSUPPORTED_MEDIA_TYPEUPGRADE_REQUIREDURI_TOO_LONGUSE_PROXYVARIANT_ALSO_NEGOTIATES

statusCountValueinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('/egov-wf/process/_statuscount?tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "result": [
    "text"
  ],
  "statusCode": "ACCEPTED"
}

Get the list of escalate 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/egov-wf/process/escalate/_search

Query parameters

Body

*/*

Parameter to carry Request metadata in the request body

apiId*string

unique API ID

ver*string

API version - for HTTP based request this will be same as used in path

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoUserInfo (object)

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstring

Response

200400

Application(s) Retrived Successfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

Request

JavaScriptCurlPython

const response = await fetch('/egov-wf/process/escalate/_search?tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "msgId": "text",
      "ver": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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"
          }
        }
      ],
      "assigner": {
        "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": false,
        "dob": "2024-11-07",
        "pwdExpiryDate": "2024-11-07",
        "locale": "text",
        "type": "text",
        "signature": "text",
        "accountLocked": false,
        "roles": [
          {
            "name": "text",
            "code": "text",
            "description": "text",
            "createdDate": "2024-11-07",
            "lastModifiedDate": "2024-11-07",
            "tenantId": "text"
          }
        ],
        "fatherOrHusbandName": "text",
        "bloodGroup": "text",
        "identificationMark": "text",
        "photo": "text",
        "createdDate": "2024-11-07",
        "lastModifiedDate": "2024-11-07",
        "otpReference": "text",
        "tenantId": "text"
      },
      "assignes": [
        {
          "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": false,
          "dob": "2024-11-07",
          "pwdExpiryDate": "2024-11-07",
          "locale": "text",
          "type": "text",
          "signature": "text",
          "accountLocked": false,
          "roles": [
            {
              "name": "text",
              "code": "text",
              "description": "text",
              "createdDate": "2024-11-07",
              "lastModifiedDate": "2024-11-07",
              "tenantId": "text"
            }
          ],
          "fatherOrHusbandName": "text",
          "bloodGroup": "text",
          "identificationMark": "text",
          "photo": "text",
          "createdDate": "2024-11-07",
          "lastModifiedDate": "2024-11-07",
          "otpReference": "text",
          "tenantId": "text"
        }
      ],
      "nextActions": [
        "text"
      ],
      "currentStatus": "text",
      "previousStatus": "text",
      "entity": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

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/egov-wf/auto/{businessService}/_escalate

Path parameters

businessService*string

Name of the workflow confguration.

Query parameters

Body

*/*

Parameter to carry Request metadata in the request body

apiId*string

unique API ID

ver*string

API version - for HTTP based request this will be same as used in path

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoUserInfo (object)

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstring

Response

200400

Application(s) Retrived Successfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

Request

JavaScriptCurlPython

const response = await fetch('/egov-wf/auto/{businessService}/_escalate?tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "msgId": "text",
      "ver": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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"
          }
        }
      ],
      "assigner": {
        "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": false,
        "dob": "2024-11-07",
        "pwdExpiryDate": "2024-11-07",
        "locale": "text",
        "type": "text",
        "signature": "text",
        "accountLocked": false,
        "roles": [
          {
            "name": "text",
            "code": "text",
            "description": "text",
            "createdDate": "2024-11-07",
            "lastModifiedDate": "2024-11-07",
            "tenantId": "text"
          }
        ],
        "fatherOrHusbandName": "text",
        "bloodGroup": "text",
        "identificationMark": "text",
        "photo": "text",
        "createdDate": "2024-11-07",
        "lastModifiedDate": "2024-11-07",
        "otpReference": "text",
        "tenantId": "text"
      },
      "assignes": [
        {
          "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": false,
          "dob": "2024-11-07",
          "pwdExpiryDate": "2024-11-07",
          "locale": "text",
          "type": "text",
          "signature": "text",
          "accountLocked": false,
          "roles": [
            {
              "name": "text",
              "code": "text",
              "description": "text",
              "createdDate": "2024-11-07",
              "lastModifiedDate": "2024-11-07",
              "tenantId": "text"
            }
          ],
          "fatherOrHusbandName": "text",
          "bloodGroup": "text",
          "identificationMark": "text",
          "photo": "text",
          "createdDate": "2024-11-07",
          "lastModifiedDate": "2024-11-07",
          "otpReference": "text",
          "tenantId": "text"
        }
      ],
      "nextActions": [
        "text"
      ],
      "currentStatus": "text",
      "previousStatus": "text",
      "entity": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Create new v2 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/egov-wf/businessservice/v2/_create

Body

*/*

Details for the new BusinessService(s) + RequestInfo meta data.

RequestInfoRequestInfo (object)

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.

BusinessServicearray of BusinessService (object)

Used for search result and create only

Response

201400

ReponseInfo withBusinessService(s) created successfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

BusinessServicearray of BusinessService (object)

Used for search result and create only

Request

JavaScriptCurlPython

const response = await fetch('/egov-wf/businessservice/v2/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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": false,
          "isStartState": false,
          "isTerminateState": false,
          "actions": [
            {
              "uuid": "text",
              "tenantId": "text",
              "stateId": "text",
              "action": "text",
              "nextStateId": "text",
              "roles": [
                "text"
              ],
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text"
              }
            }
          ],
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Updates a existing v2 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/egov-wf/businessservice/v2/_update

Body

*/*

Details for the new BusinessService(s) + RequestInfo meta data.

RequestInfoRequestInfo (object)

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.

BusinessServicearray of BusinessService (object)

Used for search result and create only

Response

201400

ReponseInfo withBusinessService(s) created successfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

BusinessServicearray of BusinessService (object)

Used for search result and create only

Request

JavaScriptCurlPython

const response = await fetch('/egov-wf/businessservice/v2/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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": false,
          "isStartState": false,
          "isTerminateState": false,
          "actions": [
            {
              "uuid": "text",
              "tenantId": "text",
              "stateId": "text",
              "action": "text",
              "nextStateId": "text",
              "roles": [
                "text"
              ],
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text"
              }
            }
          ],
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Get the list of v2 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/egov-wf/businessservice/v2/_search

Query parameters

Body

*/*

Parameter to carry Request metadata in the request body

apiId*string

unique API ID

ver*string

API version - for HTTP based request this will be same as used in path

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoUserInfo (object)

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstring

Response

200400

Trade License(s) Retrived Successfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

BusinessServicearray of BusinessService (object)

Used for search result and create only

Request

JavaScriptCurlPython

const response = await fetch('/egov-wf/businessservice/v2/_search?tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "msgId": "text",
      "ver": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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": false,
          "isStartState": false,
          "isTerminateState": false,
          "actions": [
            {
              "uuid": "text",
              "tenantId": "text",
              "stateId": "text",
              "action": "text",
              "nextStateId": "text",
              "roles": [
                "text"
              ],
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text"
              }
            }
          ],
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

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/egov-wf/businessservice/_create

Body

*/*

Details for the new BusinessService(s) + RequestInfo meta data.

RequestInfoRequestInfo (object)

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.

BusinessServicearray of BusinessService (object)

Used for search result and create only

Response

201400

ReponseInfo withBusinessService(s) created successfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

BusinessServicearray of BusinessService (object)

Used for search result and create only

Request

JavaScriptCurlPython

const response = await fetch('/egov-wf/businessservice/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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": false,
          "isStartState": false,
          "isTerminateState": false,
          "actions": [
            {
              "uuid": "text",
              "tenantId": "text",
              "stateId": "text",
              "action": "text",
              "nextStateId": "text",
              "roles": [
                "text"
              ],
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text"
              }
            }
          ],
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

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/egov-wf/businessservice/_update

Body

*/*

Details for the new BusinessService(s) + RequestInfo meta data.

RequestInfoRequestInfo (object)

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.

BusinessServicearray of BusinessService (object)

Used for search result and create only

Response

201400

ReponseInfo withBusinessService(s) created successfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

BusinessServicearray of BusinessService (object)

Used for search result and create only

Request

JavaScriptCurlPython

const response = await fetch('/egov-wf/businessservice/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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": false,
          "isStartState": false,
          "isTerminateState": false,
          "actions": [
            {
              "uuid": "text",
              "tenantId": "text",
              "stateId": "text",
              "action": "text",
              "nextStateId": "text",
              "roles": [
                "text"
              ],
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text"
              }
            }
          ],
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

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/egov-wf/businessservice/_search

Query parameters

Body

*/*

Parameter to carry Request metadata in the request body

apiId*string

unique API ID

ver*string

API version - for HTTP based request this will be same as used in path

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoUserInfo (object)

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

correlationIdstring

Response

200400

Trade License(s) Retrived Successfully

Body

*/*

ResponseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

BusinessServicearray of BusinessService (object)

Used for search result and create only

Request

JavaScriptCurlPython

const response = await fetch('/egov-wf/businessservice/_search?tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "msgId": "text",
      "ver": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "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": false,
          "isStartState": false,
          "isTerminateState": false,
          "actions": [
            {
              "uuid": "text",
              "tenantId": "text",
              "stateId": "text",
              "action": "text",
              "nextStateId": "text",
              "roles": [
                "text"
              ],
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text"
              }
            }
          ],
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text"
          }
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}