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 -

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.

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.

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

idstring

Unique process instance id (UUID)

tenantId*string

Unique Identifier of ULB

businessService*string

Business service key.

businessId*string

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

action*string

Actions are define for each business service.

statestring

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

commentstring

consumer can pass the comment on each action.

documentsarray of Document (object)

Documents can be attached with each of the action.

idstring

State Unique Identifier uuid

tenantId*string

Unique Identifier of ULB

documentType*string

1.Unique document type code from common master. 2. This is defined under mdms common master. 3. Object defination is defined under 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/DocumentType'

fileStoreId*string

Unique file store id of uploaded document.

documentUidstring

document number(eg.Pan number, aadhar number).

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

assignerUser (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

assignesarray of User (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

nextActionsarray of string

Wf will return next possible action based on .

itemsstring

slainteger (int64)

Date from when license is valid as epoch.

currentStatusstring

Status after action performed

previousStatusstring

Status before action performed

entityobject

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Response

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.

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

idstring

Unique process instance id (UUID)

tenantId*string

Unique Identifier of ULB

businessService*string

Business service key.

businessId*string

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

action*string

Actions are define for each business service.

statestring

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

commentstring

consumer can pass the comment on each action.

documentsarray of Document (object)

Documents can be attached with each of the action.

idstring

State Unique Identifier uuid

tenantId*string

Unique Identifier of ULB

documentType*string

fileStoreId*string

Unique file store id of uploaded document.

documentUidstring

document number(eg.Pan number, aadhar number).

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

assignerUser (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

assignesarray of User (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

nextActionsarray of string

Wf will return next possible action based on .

itemsstring

slainteger (int64)

Date from when license is valid as epoch.

currentStatusstring

Status after action performed

previousStatusstring

Status before action performed

entityobject

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

Response

{
  "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-21",
        "pwdExpiryDate": "2024-11-21",
        "locale": "text",
        "type": "text",
        "signature": "text",
        "accountLocked": false,
        "roles": [
          {
            "name": "text",
            "code": "text",
            "description": "text",
            "createdDate": "2024-11-21",
            "lastModifiedDate": "2024-11-21",
            "tenantId": "text"
          }
        ],
        "fatherOrHusbandName": "text",
        "bloodGroup": "text",
        "identificationMark": "text",
        "photo": "text",
        "createdDate": "2024-11-21",
        "lastModifiedDate": "2024-11-21",
        "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-21",
          "pwdExpiryDate": "2024-11-21",
          "locale": "text",
          "type": "text",
          "signature": "text",
          "accountLocked": false,
          "roles": [
            {
              "name": "text",
              "code": "text",
              "description": "text",
              "createdDate": "2024-11-21",
              "lastModifiedDate": "2024-11-21",
              "tenantId": "text"
            }
          ],
          "fatherOrHusbandName": "text",
          "bloodGroup": "text",
          "identificationMark": "text",
          "photo": "text",
          "createdDate": "2024-11-21",
          "lastModifiedDate": "2024-11-21",
          "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.

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.

POST/egov-wf/process/_search

Query parameters

tenantId*string (varchar)

Unique id for a tenant.

idsarray of integer (int64)

unique identifier of Application

itemsinteger (int64)

businessServicestring

Name of the workflow confguration.

moduleNamestring

Module name to which workflow application belongs

businessIdsarray of string

The list of businessIds

itemsstring

assigneestring

The unique Old license number for a Application.

historyboolean

Boolean flag to return history of the workflow

limitinteger

Number of records to be returned

offsetinteger

Starting offset for returning search response

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

Response

Application(s) Retrived Successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

idstring

Unique process instance id (UUID)

tenantId*string

Unique Identifier of ULB

businessService*string

Business service key.

businessId*string

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

action*string

Actions are define for each business service.

statestring

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

commentstring

consumer can pass the comment on each action.

documentsarray of Document (object)

Documents can be attached with each of the action.

idstring

State Unique Identifier uuid

tenantId*string

Unique Identifier of ULB

documentType*string

fileStoreId*string

Unique file store id of uploaded document.

documentUidstring

document number(eg.Pan number, aadhar number).

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

assignerUser (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

assignesarray of User (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

nextActionsarray of string

Wf will return next possible action based on .

itemsstring

slainteger (int64)

Date from when license is valid as epoch.

currentStatusstring

Status after action performed

previousStatusstring

Status before action performed

entityobject

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

{
  "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-21",
        "pwdExpiryDate": "2024-11-21",
        "locale": "text",
        "type": "text",
        "signature": "text",
        "accountLocked": false,
        "roles": [
          {
            "name": "text",
            "code": "text",
            "description": "text",
            "createdDate": "2024-11-21",
            "lastModifiedDate": "2024-11-21",
            "tenantId": "text"
          }
        ],
        "fatherOrHusbandName": "text",
        "bloodGroup": "text",
        "identificationMark": "text",
        "photo": "text",
        "createdDate": "2024-11-21",
        "lastModifiedDate": "2024-11-21",
        "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-21",
          "pwdExpiryDate": "2024-11-21",
          "locale": "text",
          "type": "text",
          "signature": "text",
          "accountLocked": false,
          "roles": [
            {
              "name": "text",
              "code": "text",
              "description": "text",
              "createdDate": "2024-11-21",
              "lastModifiedDate": "2024-11-21",
              "tenantId": "text"
            }
          ],
          "fatherOrHusbandName": "text",
          "bloodGroup": "text",
          "identificationMark": "text",
          "photo": "text",
          "createdDate": "2024-11-21",
          "lastModifiedDate": "2024-11-21",
          "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

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

POST/egov-wf/process/_count

Query parameters

tenantId*string (varchar)

Unique id for a tenant.

idsarray of integer (int64)

unique identifier of trade licence

itemsinteger (int64)

businessServicestring

Unique application number for a trade license application.

businessIdsarray of integer (int64)

The list of businessIds

itemsinteger (int64)

assigneestring

The unique Old license number for a Trade license.

historyboolean

Boolean flag to return history of the workflow

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

Response

Trade License(s) Retrived Successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

idstring

Unique process instance id (UUID)

tenantId*string

Unique Identifier of ULB

businessService*string

Business service key.

businessId*string

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

action*string

Actions are define for each business service.

statestring

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

commentstring

consumer can pass the comment on each action.

documentsarray of Document (object)

Documents can be attached with each of the action.

idstring

State Unique Identifier uuid

tenantId*string

Unique Identifier of ULB

documentType*string

fileStoreId*string

Unique file store id of uploaded document.

documentUidstring

document number(eg.Pan number, aadhar number).

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

assignerUser (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

assignesarray of User (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

nextActionsarray of string

Wf will return next possible action based on .

itemsstring

slainteger (int64)

Date from when license is valid as epoch.

currentStatusstring

Status after action performed

previousStatusstring

Status before action performed

entityobject

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

{
  "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-21",
        "pwdExpiryDate": "2024-11-21",
        "locale": "text",
        "type": "text",
        "signature": "text",
        "accountLocked": false,
        "roles": [
          {
            "name": "text",
            "code": "text",
            "description": "text",
            "createdDate": "2024-11-21",
            "lastModifiedDate": "2024-11-21",
            "tenantId": "text"
          }
        ],
        "fatherOrHusbandName": "text",
        "bloodGroup": "text",
        "identificationMark": "text",
        "photo": "text",
        "createdDate": "2024-11-21",
        "lastModifiedDate": "2024-11-21",
        "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-21",
          "pwdExpiryDate": "2024-11-21",
          "locale": "text",
          "type": "text",
          "signature": "text",
          "accountLocked": false,
          "roles": [
            {
              "name": "text",
              "code": "text",
              "description": "text",
              "createdDate": "2024-11-21",
              "lastModifiedDate": "2024-11-21",
              "tenantId": "text"
            }
          ],
          "fatherOrHusbandName": "text",
          "bloodGroup": "text",
          "identificationMark": "text",
          "photo": "text",
          "createdDate": "2024-11-21",
          "lastModifiedDate": "2024-11-21",
          "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.

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.

POST/egov-wf/process/_nearingslacount

Query parameters

tenantId*string (varchar)

Unique id for a tenant.

idsarray of integer (int64)

unique identifier of Application

itemsinteger (int64)

businessServicestring

Name of the workflow confguration.

moduleNamestring

Module name to which workflow application belongs

businessIdsarray of string

The list of businessIds

itemsstring

assigneestring

The unique Old license number for a Application.

historyboolean

Boolean flag to return history of the workflow

limitinteger

Number of records to be returned

offsetinteger

Starting offset for returning search response

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

Response

Application(s) Retrived Successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

Countinteger

ProcessInstancesarray of ProcessIntanceResponse (object)

Used for search result and create only

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

idstring

Unique process instance id (UUID)

tenantId*string

Unique Identifier of ULB

businessService*string

Business service key.

businessId*string

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

action*string

Actions are define for each business service.

statestring

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

commentstring

consumer can pass the comment on each action.

documentsarray of Document (object)

Documents can be attached with each of the action.

idstring

State Unique Identifier uuid

tenantId*string

Unique Identifier of ULB

documentType*string

fileStoreId*string

Unique file store id of uploaded document.

documentUidstring

document number(eg.Pan number, aadhar number).

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

assignerUser (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

assignesarray of User (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

nextActionsarray of string

Wf will return next possible action based on .

itemsstring

slainteger (int64)

Date from when license is valid as epoch.

currentStatusstring

Status after action performed

previousStatusstring

Status before action performed

entityobject

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

{
  "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-21",
            "pwdExpiryDate": "2024-11-21",
            "locale": "text",
            "type": "text",
            "signature": "text",
            "accountLocked": false,
            "roles": [
              {
                "name": "text",
                "code": "text",
                "description": "text",
                "createdDate": "2024-11-21",
                "lastModifiedDate": "2024-11-21",
                "tenantId": "text"
              }
            ],
            "fatherOrHusbandName": "text",
            "bloodGroup": "text",
            "identificationMark": "text",
            "photo": "text",
            "createdDate": "2024-11-21",
            "lastModifiedDate": "2024-11-21",
            "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-21",
              "pwdExpiryDate": "2024-11-21",
              "locale": "text",
              "type": "text",
              "signature": "text",
              "accountLocked": false,
              "roles": [
                {
                  "name": "text",
                  "code": "text",
                  "description": "text",
                  "createdDate": "2024-11-21",
                  "lastModifiedDate": "2024-11-21",
                  "tenantId": "text"
                }
              ],
              "fatherOrHusbandName": "text",
              "bloodGroup": "text",
              "identificationMark": "text",
              "photo": "text",
              "createdDate": "2024-11-21",
              "lastModifiedDate": "2024-11-21",
              "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.

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.

POST/egov-wf/process/_statuscount

Query parameters

tenantId*string (varchar)

Unique id for a tenant.

idsarray of integer (int64)

unique identifier of Application

itemsinteger (int64)

businessServicestring

Name of the workflow confguration.

moduleNamestring

Module name to which workflow application belongs

businessIdsarray of string

The list of businessIds

itemsstring

assigneestring

The unique Old license number for a Application.

historyboolean

Boolean flag to return history of the workflow

limitinteger

Number of records to be returned

offsetinteger

Starting offset for returning search response

Body

Parameter to carry Request metadata in the request body

RequestInfoRequestInfo (object)

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

ProcessInstanceSearchCriteriaProcessInstanceSearchCriteria (object)

tenantIdstring

statusstring

status of request processing - to be enhanced in futuer to include INPROGRESS

businessIdsstring

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

assigneestring

The unique Old license number for a Application.

idsarray of string

unique identifier of Application

itemsstring

historyboolean

Boolean flag to return history of the workflow

fromDateinteger (int64)

Date from which the operation is registered

toDateinteger (int64)

Date to which the operation is registered

offsetinteger

Starting offset for returning search response

limitinteger

Number of records to be returned

businessServicestring

Used for search result and create only

moduleNamestring

Module name to which workflow application belongs

Response

Application(s) Retrived Successfully

Body

bodyobject

resultarray of string

itemsstring

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

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

Response

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

Get the list of escalate workflow applications defined in the system.

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.

POST/egov-wf/process/escalate/_search

Query parameters

tenantId*string (varchar)

Unique id for a tenant.

idsarray of integer (int64)

unique identifier of Application

itemsinteger (int64)

businessServicestring

Name of the workflow confguration.

moduleNamestring

Module name to which workflow application belongs

businessIdsarray of string

The list of businessIds

itemsstring

assigneestring

The unique Old license number for a Application.

historyboolean

Boolean flag to return history of the workflow

limitinteger

Number of records to be returned

offsetinteger

Starting offset for returning search response

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

Response

Application(s) Retrived Successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

idstring

Unique process instance id (UUID)

tenantId*string

Unique Identifier of ULB

businessService*string

Business service key.

businessId*string

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

action*string

Actions are define for each business service.

statestring

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

commentstring

consumer can pass the comment on each action.

documentsarray of Document (object)

Documents can be attached with each of the action.

idstring

State Unique Identifier uuid

tenantId*string

Unique Identifier of ULB

documentType*string

fileStoreId*string

Unique file store id of uploaded document.

documentUidstring

document number(eg.Pan number, aadhar number).

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

assignerUser (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

assignesarray of User (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

nextActionsarray of string

Wf will return next possible action based on .

itemsstring

slainteger (int64)

Date from when license is valid as epoch.

currentStatusstring

Status after action performed

previousStatusstring

Status before action performed

entityobject

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

{
  "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-21",
        "pwdExpiryDate": "2024-11-21",
        "locale": "text",
        "type": "text",
        "signature": "text",
        "accountLocked": false,
        "roles": [
          {
            "name": "text",
            "code": "text",
            "description": "text",
            "createdDate": "2024-11-21",
            "lastModifiedDate": "2024-11-21",
            "tenantId": "text"
          }
        ],
        "fatherOrHusbandName": "text",
        "bloodGroup": "text",
        "identificationMark": "text",
        "photo": "text",
        "createdDate": "2024-11-21",
        "lastModifiedDate": "2024-11-21",
        "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-21",
          "pwdExpiryDate": "2024-11-21",
          "locale": "text",
          "type": "text",
          "signature": "text",
          "accountLocked": false,
          "roles": [
            {
              "name": "text",
              "code": "text",
              "description": "text",
              "createdDate": "2024-11-21",
              "lastModifiedDate": "2024-11-21",
              "tenantId": "text"
            }
          ],
          "fatherOrHusbandName": "text",
          "bloodGroup": "text",
          "identificationMark": "text",
          "photo": "text",
          "createdDate": "2024-11-21",
          "lastModifiedDate": "2024-11-21",
          "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.

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.

POST/egov-wf/auto/{businessService}/_escalate

Path parameters

businessService*string

Name of the workflow confguration.

Query parameters

tenantId*string (varchar)

Unique id for a tenant.

idsarray of integer (int64)

unique identifier of Application

itemsinteger (int64)

moduleNamestring

Module name to which workflow application belongs

businessIdsarray of string

The list of businessIds

itemsstring

assigneestring

The unique Old license number for a Application.

historyboolean

Boolean flag to return history of the workflow

limitinteger

Number of records to be returned

offsetinteger

Starting offset for returning search response

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

Response

Application(s) Retrived Successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

idstring

Unique process instance id (UUID)

tenantId*string

Unique Identifier of ULB

businessService*string

Business service key.

businessId*string

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

action*string

Actions are define for each business service.

statestring

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

commentstring

consumer can pass the comment on each action.

documentsarray of Document (object)

Documents can be attached with each of the action.

idstring

State Unique Identifier uuid

tenantId*string

Unique Identifier of ULB

documentType*string

fileStoreId*string

Unique file store id of uploaded document.

documentUidstring

document number(eg.Pan number, aadhar number).

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

assignerUser (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

assignesarray of User (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

nextActionsarray of string

Wf will return next possible action based on .

itemsstring

slainteger (int64)

Date from when license is valid as epoch.

currentStatusstring

Status after action performed

previousStatusstring

Status before action performed

entityobject

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

{
  "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-21",
        "pwdExpiryDate": "2024-11-21",
        "locale": "text",
        "type": "text",
        "signature": "text",
        "accountLocked": false,
        "roles": [
          {
            "name": "text",
            "code": "text",
            "description": "text",
            "createdDate": "2024-11-21",
            "lastModifiedDate": "2024-11-21",
            "tenantId": "text"
          }
        ],
        "fatherOrHusbandName": "text",
        "bloodGroup": "text",
        "identificationMark": "text",
        "photo": "text",
        "createdDate": "2024-11-21",
        "lastModifiedDate": "2024-11-21",
        "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-21",
          "pwdExpiryDate": "2024-11-21",
          "locale": "text",
          "type": "text",
          "signature": "text",
          "accountLocked": false,
          "roles": [
            {
              "name": "text",
              "code": "text",
              "description": "text",
              "createdDate": "2024-11-21",
              "lastModifiedDate": "2024-11-21",
              "tenantId": "text"
            }
          ],
          "fatherOrHusbandName": "text",
          "bloodGroup": "text",
          "identificationMark": "text",
          "photo": "text",
          "createdDate": "2024-11-21",
          "lastModifiedDate": "2024-11-21",
          "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 -

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

POST/egov-wf/businessservice/v2/_create

Body

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

RequestInfoRequestInfo (object)

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

BusinessServicearray of BusinessService (object)

Used for search result and create only

tenantId*string

Unique Identifier of ULB

uuidstring

Unique Identifier uuid

businessService*string

Unique Identifier of the Trade License (UUID)

getUristring

Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.

postUristring

statesarray of State (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

Unique Identifier of ULB

businessServiceIdstring

Unique Identifier of the Trade License (UUID)

statestring

applicationStatusstring

Application status as in module

docUploadRequiredboolean

Boolean to describe if documents are mandatory

isStartStateboolean

Boolean to describe if the workflow can be started from this state

isTerminateStateboolean

Boolean to describe if the state is the last state of workflow

actionsarray of Action (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

TenantId of the ULB

stateIdstring

The uuid of the state on which action is to performed

actionstring

The action to be performed

nextStateIdstring

The uuid of the resultant state

rolesarray of string

Used for search result and create only

itemsstring

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Response

ReponseInfo withBusinessService(s) created successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

BusinessServicearray of BusinessService (object)

Used for search result and create only

tenantId*string

Unique Identifier of ULB

uuidstring

Unique Identifier uuid

businessService*string

Unique Identifier of the Trade License (UUID)

getUristring

postUristring

statesarray of State (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

Unique Identifier of ULB

businessServiceIdstring

Unique Identifier of the Trade License (UUID)

statestring

applicationStatusstring

Application status as in module

docUploadRequiredboolean

Boolean to describe if documents are mandatory

isStartStateboolean

Boolean to describe if the workflow can be started from this state

isTerminateStateboolean

Boolean to describe if the state is the last state of workflow

actionsarray of Action (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

TenantId of the ULB

stateIdstring

The uuid of the state on which action is to performed

actionstring

The action to be performed

nextStateIdstring

The uuid of the resultant state

rolesarray of string

Used for search result and create only

itemsstring

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

Response

{
  "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 -

can add states and actions
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)

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

BusinessServicearray of BusinessService (object)

Used for search result and create only

tenantId*string

Unique Identifier of ULB

uuidstring

Unique Identifier uuid

businessService*string

Unique Identifier of the Trade License (UUID)

getUristring

postUristring

statesarray of State (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

Unique Identifier of ULB

businessServiceIdstring

Unique Identifier of the Trade License (UUID)

statestring

applicationStatusstring

Application status as in module

docUploadRequiredboolean

Boolean to describe if documents are mandatory

isStartStateboolean

Boolean to describe if the workflow can be started from this state

isTerminateStateboolean

Boolean to describe if the state is the last state of workflow

actionsarray of Action (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

TenantId of the ULB

stateIdstring

The uuid of the state on which action is to performed

actionstring

The action to be performed

nextStateIdstring

The uuid of the resultant state

rolesarray of string

Used for search result and create only

itemsstring

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Response

ReponseInfo withBusinessService(s) created successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

BusinessServicearray of BusinessService (object)

Used for search result and create only

tenantId*string

Unique Identifier of ULB

uuidstring

Unique Identifier uuid

businessService*string

Unique Identifier of the Trade License (UUID)

getUristring

postUristring

statesarray of State (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

Unique Identifier of ULB

businessServiceIdstring

Unique Identifier of the Trade License (UUID)

statestring

applicationStatusstring

Application status as in module

docUploadRequiredboolean

Boolean to describe if documents are mandatory

isStartStateboolean

Boolean to describe if the workflow can be started from this state

isTerminateStateboolean

Boolean to describe if the state is the last state of workflow

actionsarray of Action (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

TenantId of the ULB

stateIdstring

The uuid of the state on which action is to performed

actionstring

The action to be performed

nextStateIdstring

The uuid of the resultant state

rolesarray of string

Used for search result and create only

itemsstring

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

Response

{
  "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.

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.

POST/egov-wf/businessservice/v2/_search

Query parameters

businessServicesarray of integer (int64)

BusinessService code of the businessService

itemsinteger (int64)

tenantId*string (varchar)

Unique id for a tenant.

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

Response

Trade License(s) Retrived Successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

BusinessServicearray of BusinessService (object)

Used for search result and create only

tenantId*string

Unique Identifier of ULB

uuidstring

Unique Identifier uuid

businessService*string

Unique Identifier of the Trade License (UUID)

getUristring

postUristring

statesarray of State (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

Unique Identifier of ULB

businessServiceIdstring

Unique Identifier of the Trade License (UUID)

statestring

applicationStatusstring

Application status as in module

docUploadRequiredboolean

Boolean to describe if documents are mandatory

isStartStateboolean

Boolean to describe if the workflow can be started from this state

isTerminateStateboolean

Boolean to describe if the state is the last state of workflow

actionsarray of Action (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

TenantId of the ULB

stateIdstring

The uuid of the state on which action is to performed

actionstring

The action to be performed

nextStateIdstring

The uuid of the resultant state

rolesarray of string

Used for search result and create only

itemsstring

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

{
  "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.

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

POST/egov-wf/businessservice/_create

Body

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

RequestInfoRequestInfo (object)

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

BusinessServicearray of BusinessService (object)

Used for search result and create only

tenantId*string

Unique Identifier of ULB

uuidstring

Unique Identifier uuid

businessService*string

Unique Identifier of the Trade License (UUID)

getUristring

postUristring

statesarray of State (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

Unique Identifier of ULB

businessServiceIdstring

Unique Identifier of the Trade License (UUID)

statestring

applicationStatusstring

Application status as in module

docUploadRequiredboolean

Boolean to describe if documents are mandatory

isStartStateboolean

Boolean to describe if the workflow can be started from this state

isTerminateStateboolean

Boolean to describe if the state is the last state of workflow

actionsarray of Action (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

TenantId of the ULB

stateIdstring

The uuid of the state on which action is to performed

actionstring

The action to be performed

nextStateIdstring

The uuid of the resultant state

rolesarray of string

Used for search result and create only

itemsstring

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Response

ReponseInfo withBusinessService(s) created successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

BusinessServicearray of BusinessService (object)

Used for search result and create only

tenantId*string

Unique Identifier of ULB

uuidstring

Unique Identifier uuid

businessService*string

Unique Identifier of the Trade License (UUID)

getUristring

postUristring

statesarray of State (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

Unique Identifier of ULB

businessServiceIdstring

Unique Identifier of the Trade License (UUID)

statestring

applicationStatusstring

Application status as in module

docUploadRequiredboolean

Boolean to describe if documents are mandatory

isStartStateboolean

Boolean to describe if the workflow can be started from this state

isTerminateStateboolean

Boolean to describe if the state is the last state of workflow

actionsarray of Action (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

TenantId of the ULB

stateIdstring

The uuid of the state on which action is to performed

actionstring

The action to be performed

nextStateIdstring

The uuid of the resultant state

rolesarray of string

Used for search result and create only

itemsstring

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

Response

{
  "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 -

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

POST/egov-wf/businessservice/_update

Body

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

RequestInfoRequestInfo (object)

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

BusinessServicearray of BusinessService (object)

Used for search result and create only

tenantId*string

Unique Identifier of ULB

uuidstring

Unique Identifier uuid

businessService*string

Unique Identifier of the Trade License (UUID)

getUristring

postUristring

statesarray of State (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

Unique Identifier of ULB

businessServiceIdstring

Unique Identifier of the Trade License (UUID)

statestring

applicationStatusstring

Application status as in module

docUploadRequiredboolean

Boolean to describe if documents are mandatory

isStartStateboolean

Boolean to describe if the workflow can be started from this state

isTerminateStateboolean

Boolean to describe if the state is the last state of workflow

actionsarray of Action (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

TenantId of the ULB

stateIdstring

The uuid of the state on which action is to performed

actionstring

The action to be performed

nextStateIdstring

The uuid of the resultant state

rolesarray of string

Used for search result and create only

itemsstring

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Response

ReponseInfo withBusinessService(s) created successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

BusinessServicearray of BusinessService (object)

Used for search result and create only

tenantId*string

Unique Identifier of ULB

uuidstring

Unique Identifier uuid

businessService*string

Unique Identifier of the Trade License (UUID)

getUristring

postUristring

statesarray of State (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

Unique Identifier of ULB

businessServiceIdstring

Unique Identifier of the Trade License (UUID)

statestring

applicationStatusstring

Application status as in module

docUploadRequiredboolean

Boolean to describe if documents are mandatory

isStartStateboolean

Boolean to describe if the workflow can be started from this state

isTerminateStateboolean

Boolean to describe if the state is the last state of workflow

actionsarray of Action (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

TenantId of the ULB

stateIdstring

The uuid of the state on which action is to performed

actionstring

The action to be performed

nextStateIdstring

The uuid of the resultant state

rolesarray of string

Used for search result and create only

itemsstring

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

Response

{
  "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.

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.

POST/egov-wf/businessservice/_search

Query parameters

businessServicesarray of integer (int64)

BusinessService code of the businessService

itemsinteger (int64)

tenantId*string (varchar)

Unique id for a tenant.

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

Response

Trade License(s) Retrived Successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

BusinessServicearray of BusinessService (object)

Used for search result and create only

tenantId*string

Unique Identifier of ULB

uuidstring

Unique Identifier uuid

businessService*string

Unique Identifier of the Trade License (UUID)

getUristring

postUristring

statesarray of State (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

Unique Identifier of ULB

businessServiceIdstring

Unique Identifier of the Trade License (UUID)

statestring

applicationStatusstring

Application status as in module

docUploadRequiredboolean

Boolean to describe if documents are mandatory

isStartStateboolean

Boolean to describe if the workflow can be started from this state

isTerminateStateboolean

Boolean to describe if the state is the last state of workflow

actionsarray of Action (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

TenantId of the ULB

stateIdstring

The uuid of the state on which action is to performed

actionstring

The action to be performed

nextStateIdstring

The uuid of the resultant state

rolesarray of string

Used for search result and create only

itemsstring

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

{
  "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 workflow applications defined in the system.

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.

POST/egov-wf/auto/{businessService}/_escalate

Path parameters

businessService*string

Name of the workflow confguration.

Query parameters

tenantId*string (varchar)

Unique id for a tenant.

idsarray of integer (int64)

unique identifier of Application

itemsinteger (int64)

moduleNamestring

Module name to which workflow application belongs

businessIdsarray of string

The list of businessIds

itemsstring

assigneestring

The unique Old license number for a Application.

historyboolean

Boolean flag to return history of the workflow

limitinteger

Number of records to be returned

offsetinteger

Starting offset for returning search response

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

Response

Application(s) Retrived Successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

idstring

Unique process instance id (UUID)

tenantId*string

Unique Identifier of ULB

businessService*string

Business service key.

businessId*string

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

action*string

Actions are define for each business service.

statestring

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

commentstring

consumer can pass the comment on each action.

documentsarray of Document (object)

Documents can be attached with each of the action.

idstring

State Unique Identifier uuid

tenantId*string

Unique Identifier of ULB

documentType*string

fileStoreId*string

Unique file store id of uploaded document.

documentUidstring

document number(eg.Pan number, aadhar number).

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

assignerUser (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

assignesarray of User (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

nextActionsarray of string

Wf will return next possible action based on .

itemsstring

slainteger (int64)

Date from when license is valid as epoch.

currentStatusstring

Status after action performed

previousStatusstring

Status before action performed

entityobject

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

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

Get the list of BusinessServices defined in the system.

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.

POST/egov-wf/businessservice/_search

Query parameters

businessServicesarray of integer (int64)

BusinessService code of the businessService

itemsinteger (int64)

tenantId*string (varchar)

Unique id for a tenant.

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

Response

Trade License(s) Retrived Successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

BusinessServicearray of BusinessService (object)

Used for search result and create only

tenantId*string

Unique Identifier of ULB

uuidstring

Unique Identifier uuid

businessService*string

Unique Identifier of the Trade License (UUID)

getUristring

postUristring

statesarray of State (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

Unique Identifier of ULB

businessServiceIdstring

Unique Identifier of the Trade License (UUID)

statestring

applicationStatusstring

Application status as in module

docUploadRequiredboolean

Boolean to describe if documents are mandatory

isStartStateboolean

Boolean to describe if the workflow can be started from this state

isTerminateStateboolean

Boolean to describe if the state is the last state of workflow

actionsarray of Action (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

TenantId of the ULB

stateIdstring

The uuid of the state on which action is to performed

actionstring

The action to be performed

nextStateIdstring

The uuid of the resultant state

rolesarray of string

Used for search result and create only

itemsstring

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

{
  "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 workflow applications defined in the system.

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.

POST/egov-wf/process/_search

Query parameters

tenantId*string (varchar)

Unique id for a tenant.

idsarray of integer (int64)

unique identifier of Application

itemsinteger (int64)

businessServicestring

Name of the workflow confguration.

moduleNamestring

Module name to which workflow application belongs

businessIdsarray of string

The list of businessIds

itemsstring

assigneestring

The unique Old license number for a Application.

historyboolean

Boolean flag to return history of the workflow

limitinteger

Number of records to be returned

offsetinteger

Starting offset for returning search response

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

Response

Application(s) Retrived Successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

idstring

Unique process instance id (UUID)

tenantId*string

Unique Identifier of ULB

businessService*string

Business service key.

businessId*string

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

action*string

Actions are define for each business service.

statestring

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

commentstring

consumer can pass the comment on each action.

documentsarray of Document (object)

Documents can be attached with each of the action.

idstring

State Unique Identifier uuid

tenantId*string

Unique Identifier of ULB

documentType*string

fileStoreId*string

Unique file store id of uploaded document.

documentUidstring

document number(eg.Pan number, aadhar number).

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

assignerUser (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

assignesarray of User (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

nextActionsarray of string

Wf will return next possible action based on .

itemsstring

slainteger (int64)

Date from when license is valid as epoch.

currentStatusstring

Status after action performed

previousStatusstring

Status before action performed

entityobject

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

{
  "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-21",
        "pwdExpiryDate": "2024-11-21",
        "locale": "text",
        "type": "text",
        "signature": "text",
        "accountLocked": false,
        "roles": [
          {
            "name": "text",
            "code": "text",
            "description": "text",
            "createdDate": "2024-11-21",
            "lastModifiedDate": "2024-11-21",
            "tenantId": "text"
          }
        ],
        "fatherOrHusbandName": "text",
        "bloodGroup": "text",
        "identificationMark": "text",
        "photo": "text",
        "createdDate": "2024-11-21",
        "lastModifiedDate": "2024-11-21",
        "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-21",
          "pwdExpiryDate": "2024-11-21",
          "locale": "text",
          "type": "text",
          "signature": "text",
          "accountLocked": false,
          "roles": [
            {
              "name": "text",
              "code": "text",
              "description": "text",
              "createdDate": "2024-11-21",
              "lastModifiedDate": "2024-11-21",
              "tenantId": "text"
            }
          ],
          "fatherOrHusbandName": "text",
          "bloodGroup": "text",
          "identificationMark": "text",
          "photo": "text",
          "createdDate": "2024-11-21",
          "lastModifiedDate": "2024-11-21",
          "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.

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.

POST/egov-wf/process/_nearingslacount

Query parameters

tenantId*string (varchar)

Unique id for a tenant.

idsarray of integer (int64)

unique identifier of Application

itemsinteger (int64)

businessServicestring

Name of the workflow confguration.

moduleNamestring

Module name to which workflow application belongs

businessIdsarray of string

The list of businessIds

itemsstring

assigneestring

The unique Old license number for a Application.

historyboolean

Boolean flag to return history of the workflow

limitinteger

Number of records to be returned

offsetinteger

Starting offset for returning search response

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

Response

Application(s) Retrived Successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

Countinteger

ProcessInstancesarray of ProcessIntanceResponse (object)

Used for search result and create only

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

idstring

Unique process instance id (UUID)

tenantId*string

Unique Identifier of ULB

businessService*string

Business service key.

businessId*string

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

action*string

Actions are define for each business service.

statestring

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

commentstring

consumer can pass the comment on each action.

documentsarray of Document (object)

Documents can be attached with each of the action.

idstring

State Unique Identifier uuid

tenantId*string

Unique Identifier of ULB

documentType*string

fileStoreId*string

Unique file store id of uploaded document.

documentUidstring

document number(eg.Pan number, aadhar number).

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

assignerUser (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

assignesarray of User (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

nextActionsarray of string

Wf will return next possible action based on .

itemsstring

slainteger (int64)

Date from when license is valid as epoch.

currentStatusstring

Status after action performed

previousStatusstring

Status before action performed

entityobject

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

{
  "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-21",
            "pwdExpiryDate": "2024-11-21",
            "locale": "text",
            "type": "text",
            "signature": "text",
            "accountLocked": false,
            "roles": [
              {
                "name": "text",
                "code": "text",
                "description": "text",
                "createdDate": "2024-11-21",
                "lastModifiedDate": "2024-11-21",
                "tenantId": "text"
              }
            ],
            "fatherOrHusbandName": "text",
            "bloodGroup": "text",
            "identificationMark": "text",
            "photo": "text",
            "createdDate": "2024-11-21",
            "lastModifiedDate": "2024-11-21",
            "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-21",
              "pwdExpiryDate": "2024-11-21",
              "locale": "text",
              "type": "text",
              "signature": "text",
              "accountLocked": false,
              "roles": [
                {
                  "name": "text",
                  "code": "text",
                  "description": "text",
                  "createdDate": "2024-11-21",
                  "lastModifiedDate": "2024-11-21",
                  "tenantId": "text"
                }
              ],
              "fatherOrHusbandName": "text",
              "bloodGroup": "text",
              "identificationMark": "text",
              "photo": "text",
              "createdDate": "2024-11-21",
              "lastModifiedDate": "2024-11-21",
              "otpReference": "text",
              "tenantId": "text"
            }
          ],
          "nextActions": [
            "text"
          ],
          "currentStatus": "text",
          "previousStatus": "text",
          "entity": {},
          "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 -

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

POST/egov-wf/businessservice/_update

Body

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

RequestInfoRequestInfo (object)

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

BusinessServicearray of BusinessService (object)

Used for search result and create only

tenantId*string

Unique Identifier of ULB

uuidstring

Unique Identifier uuid

businessService*string

Unique Identifier of the Trade License (UUID)

getUristring

postUristring

statesarray of State (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

Unique Identifier of ULB

businessServiceIdstring

Unique Identifier of the Trade License (UUID)

statestring

applicationStatusstring

Application status as in module

docUploadRequiredboolean

Boolean to describe if documents are mandatory

isStartStateboolean

Boolean to describe if the workflow can be started from this state

isTerminateStateboolean

Boolean to describe if the state is the last state of workflow

actionsarray of Action (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

TenantId of the ULB

stateIdstring

The uuid of the state on which action is to performed

actionstring

The action to be performed

nextStateIdstring

The uuid of the resultant state

rolesarray of string

Used for search result and create only

itemsstring

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Response

ReponseInfo withBusinessService(s) created successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

BusinessServicearray of BusinessService (object)

Used for search result and create only

tenantId*string

Unique Identifier of ULB

uuidstring

Unique Identifier uuid

businessService*string

Unique Identifier of the Trade License (UUID)

getUristring

postUristring

statesarray of State (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

Unique Identifier of ULB

businessServiceIdstring

Unique Identifier of the Trade License (UUID)

statestring

applicationStatusstring

Application status as in module

docUploadRequiredboolean

Boolean to describe if documents are mandatory

isStartStateboolean

Boolean to describe if the workflow can be started from this state

isTerminateStateboolean

Boolean to describe if the state is the last state of workflow

actionsarray of Action (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

TenantId of the ULB

stateIdstring

The uuid of the state on which action is to performed

actionstring

The action to be performed

nextStateIdstring

The uuid of the resultant state

rolesarray of string

Used for search result and create only

itemsstring

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

Response

{
  "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.

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.

POST/egov-wf/businessservice/v2/_search

Query parameters

businessServicesarray of integer (int64)

BusinessService code of the businessService

itemsinteger (int64)

tenantId*string (varchar)

Unique id for a tenant.

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

Response

Trade License(s) Retrived Successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

BusinessServicearray of BusinessService (object)

Used for search result and create only

tenantId*string

Unique Identifier of ULB

uuidstring

Unique Identifier uuid

businessService*string

Unique Identifier of the Trade License (UUID)

getUristring

postUristring

statesarray of State (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

Unique Identifier of ULB

businessServiceIdstring

Unique Identifier of the Trade License (UUID)

statestring

applicationStatusstring

Application status as in module

docUploadRequiredboolean

Boolean to describe if documents are mandatory

isStartStateboolean

Boolean to describe if the workflow can be started from this state

isTerminateStateboolean

Boolean to describe if the state is the last state of workflow

actionsarray of Action (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

TenantId of the ULB

stateIdstring

The uuid of the state on which action is to performed

actionstring

The action to be performed

nextStateIdstring

The uuid of the resultant state

rolesarray of string

Used for search result and create only

itemsstring

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

{
  "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 -

can add states and actions
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)

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

BusinessServicearray of BusinessService (object)

Used for search result and create only

tenantId*string

Unique Identifier of ULB

uuidstring

Unique Identifier uuid

businessService*string

Unique Identifier of the Trade License (UUID)

getUristring

postUristring

statesarray of State (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

Unique Identifier of ULB

businessServiceIdstring

Unique Identifier of the Trade License (UUID)

statestring

applicationStatusstring

Application status as in module

docUploadRequiredboolean

Boolean to describe if documents are mandatory

isStartStateboolean

Boolean to describe if the workflow can be started from this state

isTerminateStateboolean

Boolean to describe if the state is the last state of workflow

actionsarray of Action (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

TenantId of the ULB

stateIdstring

The uuid of the state on which action is to performed

actionstring

The action to be performed

nextStateIdstring

The uuid of the resultant state

rolesarray of string

Used for search result and create only

itemsstring

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Response

ReponseInfo withBusinessService(s) created successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

BusinessServicearray of BusinessService (object)

Used for search result and create only

tenantId*string

Unique Identifier of ULB

uuidstring

Unique Identifier uuid

businessService*string

Unique Identifier of the Trade License (UUID)

getUristring

postUristring

statesarray of State (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

Unique Identifier of ULB

businessServiceIdstring

Unique Identifier of the Trade License (UUID)

statestring

applicationStatusstring

Application status as in module

docUploadRequiredboolean

Boolean to describe if documents are mandatory

isStartStateboolean

Boolean to describe if the workflow can be started from this state

isTerminateStateboolean

Boolean to describe if the state is the last state of workflow

actionsarray of Action (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

TenantId of the ULB

stateIdstring

The uuid of the state on which action is to performed

actionstring

The action to be performed

nextStateIdstring

The uuid of the resultant state

rolesarray of string

Used for search result and create only

itemsstring

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

Response

{
  "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 count of applications satisfying the given criteria

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

POST/egov-wf/process/_count

Query parameters

tenantId*string (varchar)

Unique id for a tenant.

idsarray of integer (int64)

unique identifier of trade licence

itemsinteger (int64)

businessServicestring

Unique application number for a trade license application.

businessIdsarray of integer (int64)

The list of businessIds

itemsinteger (int64)

assigneestring

The unique Old license number for a Trade license.

historyboolean

Boolean flag to return history of the workflow

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

Response

Trade License(s) Retrived Successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

idstring

Unique process instance id (UUID)

tenantId*string

Unique Identifier of ULB

businessService*string

Business service key.

businessId*string

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

action*string

Actions are define for each business service.

statestring

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

commentstring

consumer can pass the comment on each action.

documentsarray of Document (object)

Documents can be attached with each of the action.

idstring

State Unique Identifier uuid

tenantId*string

Unique Identifier of ULB

documentType*string

fileStoreId*string

Unique file store id of uploaded document.

documentUidstring

document number(eg.Pan number, aadhar number).

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

assignerUser (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

assignesarray of User (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

nextActionsarray of string

Wf will return next possible action based on .

itemsstring

slainteger (int64)

Date from when license is valid as epoch.

currentStatusstring

Status after action performed

previousStatusstring

Status before action performed

entityobject

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

{
  "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-21",
        "pwdExpiryDate": "2024-11-21",
        "locale": "text",
        "type": "text",
        "signature": "text",
        "accountLocked": false,
        "roles": [
          {
            "name": "text",
            "code": "text",
            "description": "text",
            "createdDate": "2024-11-21",
            "lastModifiedDate": "2024-11-21",
            "tenantId": "text"
          }
        ],
        "fatherOrHusbandName": "text",
        "bloodGroup": "text",
        "identificationMark": "text",
        "photo": "text",
        "createdDate": "2024-11-21",
        "lastModifiedDate": "2024-11-21",
        "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-21",
          "pwdExpiryDate": "2024-11-21",
          "locale": "text",
          "type": "text",
          "signature": "text",
          "accountLocked": false,
          "roles": [
            {
              "name": "text",
              "code": "text",
              "description": "text",
              "createdDate": "2024-11-21",
              "lastModifiedDate": "2024-11-21",
              "tenantId": "text"
            }
          ],
          "fatherOrHusbandName": "text",
          "bloodGroup": "text",
          "identificationMark": "text",
          "photo": "text",
          "createdDate": "2024-11-21",
          "lastModifiedDate": "2024-11-21",
          "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.

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.

POST/egov-wf/process/_statuscount

Query parameters

tenantId*string (varchar)

Unique id for a tenant.

idsarray of integer (int64)

unique identifier of Application

itemsinteger (int64)

businessServicestring

Name of the workflow confguration.

moduleNamestring

Module name to which workflow application belongs

businessIdsarray of string

The list of businessIds

itemsstring

assigneestring

The unique Old license number for a Application.

historyboolean

Boolean flag to return history of the workflow

limitinteger

Number of records to be returned

offsetinteger

Starting offset for returning search response

Body

Parameter to carry Request metadata in the request body

RequestInfoRequestInfo (object)

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

ProcessInstanceSearchCriteriaProcessInstanceSearchCriteria (object)

tenantIdstring

statusstring

status of request processing - to be enhanced in futuer to include INPROGRESS

businessIdsstring

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

assigneestring

The unique Old license number for a Application.

idsarray of string

unique identifier of Application

itemsstring

historyboolean

Boolean flag to return history of the workflow

fromDateinteger (int64)

Date from which the operation is registered

toDateinteger (int64)

Date to which the operation is registered

offsetinteger

Starting offset for returning search response

limitinteger

Number of records to be returned

businessServicestring

Used for search result and create only

moduleNamestring

Module name to which workflow application belongs

Response

Application(s) Retrived Successfully

Body

bodyobject

resultarray of string

itemsstring

statusCodeenum

statusCountValueinteger (int32)

Request

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

Response

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

Create new BuinessService.

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

POST/egov-wf/businessservice/_create

Body

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

RequestInfoRequestInfo (object)

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

BusinessServicearray of BusinessService (object)

Used for search result and create only

tenantId*string

Unique Identifier of ULB

uuidstring

Unique Identifier uuid

businessService*string

Unique Identifier of the Trade License (UUID)

getUristring

postUristring

statesarray of State (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

Unique Identifier of ULB

businessServiceIdstring

Unique Identifier of the Trade License (UUID)

statestring

applicationStatusstring

Application status as in module

docUploadRequiredboolean

Boolean to describe if documents are mandatory

isStartStateboolean

Boolean to describe if the workflow can be started from this state

isTerminateStateboolean

Boolean to describe if the state is the last state of workflow

actionsarray of Action (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

TenantId of the ULB

stateIdstring

The uuid of the state on which action is to performed

actionstring

The action to be performed

nextStateIdstring

The uuid of the resultant state

rolesarray of string

Used for search result and create only

itemsstring

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Response

ReponseInfo withBusinessService(s) created successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

BusinessServicearray of BusinessService (object)

Used for search result and create only

tenantId*string

Unique Identifier of ULB

uuidstring

Unique Identifier uuid

businessService*string

Unique Identifier of the Trade License (UUID)

getUristring

postUristring

statesarray of State (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

Unique Identifier of ULB

businessServiceIdstring

Unique Identifier of the Trade License (UUID)

statestring

applicationStatusstring

Application status as in module

docUploadRequiredboolean

Boolean to describe if documents are mandatory

isStartStateboolean

Boolean to describe if the workflow can be started from this state

isTerminateStateboolean

Boolean to describe if the state is the last state of workflow

actionsarray of Action (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

TenantId of the ULB

stateIdstring

The uuid of the state on which action is to performed

actionstring

The action to be performed

nextStateIdstring

The uuid of the resultant state

rolesarray of string

Used for search result and create only

itemsstring

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

Response

{
  "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 v2 BuinessService.

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

POST/egov-wf/businessservice/v2/_create

Body

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

RequestInfoRequestInfo (object)

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

BusinessServicearray of BusinessService (object)

Used for search result and create only

tenantId*string

Unique Identifier of ULB

uuidstring

Unique Identifier uuid

businessService*string

Unique Identifier of the Trade License (UUID)

getUristring

postUristring

statesarray of State (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

Unique Identifier of ULB

businessServiceIdstring

Unique Identifier of the Trade License (UUID)

statestring

applicationStatusstring

Application status as in module

docUploadRequiredboolean

Boolean to describe if documents are mandatory

isStartStateboolean

Boolean to describe if the workflow can be started from this state

isTerminateStateboolean

Boolean to describe if the state is the last state of workflow

actionsarray of Action (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

TenantId of the ULB

stateIdstring

The uuid of the state on which action is to performed

actionstring

The action to be performed

nextStateIdstring

The uuid of the resultant state

rolesarray of string

Used for search result and create only

itemsstring

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Response

ReponseInfo withBusinessService(s) created successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

BusinessServicearray of BusinessService (object)

Used for search result and create only

tenantId*string

Unique Identifier of ULB

uuidstring

Unique Identifier uuid

businessService*string

Unique Identifier of the Trade License (UUID)

getUristring

postUristring

statesarray of State (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

Unique Identifier of ULB

businessServiceIdstring

Unique Identifier of the Trade License (UUID)

statestring

applicationStatusstring

Application status as in module

docUploadRequiredboolean

Boolean to describe if documents are mandatory

isStartStateboolean

Boolean to describe if the workflow can be started from this state

isTerminateStateboolean

Boolean to describe if the state is the last state of workflow

actionsarray of Action (object)

uuidstring

State Unique Identifier uuid

tenantIdstring

TenantId of the ULB

stateIdstring

The uuid of the state on which action is to performed

actionstring

The action to be performed

nextStateIdstring

The uuid of the resultant state

rolesarray of string

Used for search result and create only

itemsstring

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

Response

{
  "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 workflow entry for a given application number(businessId).

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.

POST/egov-wf/process/_transition

Body

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

RequestInfoRequestInfo (object)

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

idstring

Unique process instance id (UUID)

tenantId*string

Unique Identifier of ULB

businessService*string

Business service key.

businessId*string

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

action*string

Actions are define for each business service.

statestring

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

commentstring

consumer can pass the comment on each action.

documentsarray of Document (object)

Documents can be attached with each of the action.

idstring

State Unique Identifier uuid

tenantId*string

Unique Identifier of ULB

documentType*string

fileStoreId*string

Unique file store id of uploaded document.

documentUidstring

document number(eg.Pan number, aadhar number).

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

assignerUser (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

assignesarray of User (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

nextActionsarray of string

Wf will return next possible action based on .

itemsstring

slainteger (int64)

Date from when license is valid as epoch.

currentStatusstring

Status after action performed

previousStatusstring

Status before action performed

entityobject

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Response

ReponseInfo with Workflow(s) created successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

idstring

Unique process instance id (UUID)

tenantId*string

Unique Identifier of ULB

businessService*string

Business service key.

businessId*string

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

action*string

Actions are define for each business service.

statestring

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

commentstring

consumer can pass the comment on each action.

documentsarray of Document (object)

Documents can be attached with each of the action.

idstring

State Unique Identifier uuid

tenantId*string

Unique Identifier of ULB

documentType*string

fileStoreId*string

Unique file store id of uploaded document.

documentUidstring

document number(eg.Pan number, aadhar number).

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

assignerUser (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

assignesarray of User (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

nextActionsarray of string

Wf will return next possible action based on .

itemsstring

slainteger (int64)

Date from when license is valid as epoch.

currentStatusstring

Status after action performed

previousStatusstring

Status before action performed

entityobject

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

Response

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

Get the list of escalate workflow applications defined in the system.

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.

POST/egov-wf/process/escalate/_search

Query parameters

tenantId*string (varchar)

Unique id for a tenant.

idsarray of integer (int64)

unique identifier of Application

itemsinteger (int64)

businessServicestring

Name of the workflow confguration.

moduleNamestring

Module name to which workflow application belongs

businessIdsarray of string

The list of businessIds

itemsstring

assigneestring

The unique Old license number for a Application.

historyboolean

Boolean flag to return history of the workflow

limitinteger

Number of records to be returned

offsetinteger

Starting offset for returning search response

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.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

uuidstring

System Generated User id of the authenticated user.

userName*string

Unique user name of the authenticated user

passwordstring

password of the user.

idTokenstring

This will be the OTP.

mobilestring

mobile number of the autheticated user

emailstring

email address of the authenticated user

primaryrole*array of Role_2 (object)

List of all the roles for the primary tenant

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

additionalrolesarray of TenantRole (object)

array of additional tenantids authorized for the authenticated user

tenantId*string

tenantid for the tenant

roles*array of Role_2 (object)

Roles assigned for a particular tenant - array of role codes/names

name*string

Unique name of the role

codestring

Unique code of the role

descriptionstring

brief description of the role

correlationIdstring

Response

Application(s) Retrived Successfully

Body

ResponseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

idstring

Unique process instance id (UUID)

tenantId*string

Unique Identifier of ULB

businessService*string

Business service key.

businessId*string

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

action*string

Actions are define for each business service.

statestring

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

commentstring

consumer can pass the comment on each action.

documentsarray of Document (object)

Documents can be attached with each of the action.

idstring

State Unique Identifier uuid

tenantId*string

Unique Identifier of ULB

documentType*string

fileStoreId*string

Unique file store id of uploaded document.

documentUidstring

document number(eg.Pan number, aadhar number).

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

assignerUser (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

assignesarray of User (object)

idinteger (int64)

The unique id an user.

userName*string

The unique username used for user login.

passwordstring (password)

Password for user login.

salutationstring

The salutation of user name. Example- Mr, Miss, Mrs

name*string

The full name of the user.

gender*string

Gender of the user.

mobileNumber*string

Mobile number ofuser the user

emailIdstring

Email address of the user

altContactNumberstring

Alternate contact number of the user

panstring

PAN number of the user

aadhaarNumberstring

Aadhaar number of the user

Pattern: [0-9]

permanentAddressstring

Permanent address of the user.

permanentCitystring

City of the permanent address.

permanentPincodestring

Permanent address pincode.

correspondenceCitystring

City of the correspondence address.

correspondencePincodestring

Permanent address pincode.

correspondenceAddressstring

Correspondence address of the user.

active*boolean

True if the user is active and False if the user is inactive.

dobstring (date)

Data of bith of the user in dd/mm/yyyy format.

pwdExpiryDatestring (date)

Date on which the password registered will expire.

locale*string

Value will be set to "en_IN".

type*string

System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".

signaturestring

Image to be loaded for the signature of the employee

accountLockedboolean

Set to True if account is locked after several incorrect password attempt. False if account is not locked.

rolesarray of Role (object)

List of roles that are attached to the user.

idinteger (int64)

Unique identifier of the role.

name*string

The Name of the Role.

codestring

The Code of the Role.

descriptionstring

The description of the Role.

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the role master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the role master data was last modified.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

fatherOrHusbandNamestring

Name of user's father or husband.

bloodGroupstring

Blood group of the user.

identificationMarkstring

Any identification mark of the person.

photostring

Image to be loaded for the photo of the user

createdByinteger (int64)

Id of the user who created the record.

createdDatestring (date)

Date on which the user master data was added into the system.

lastModifiedByinteger (int64)

Id of the user who last modified the record.

lastModifiedDatestring (date)

Date on which the user master data was last modified.

otpReferencestring

This is the UUID token that we genarate as part of OTP.

tenantId*string

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

nextActionsarray of string

Wf will return next possible action based on .

itemsstring

slainteger (int64)

Date from when license is valid as epoch.

currentStatusstring

Status after action performed

previousStatusstring

Status before action performed

entityobject

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

Request

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

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