1 of 1

Workflow v2

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

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

Following Conditions are applied -

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.

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).

assignesarray

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

Response

ReponseInfo with Workflow(s) created successfully

Body

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).

assignesarray

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

Request

Response

Create new BuinessService.

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

Following Conditions are applied -

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.

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

Response

ReponseInfo withBusinessService(s) created successfully

Body

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

Request

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

Response

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

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.

any

Response

ReponseInfo withBusinessService(s) created successfully

Body

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

Request

Response

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.

any

Response

ReponseInfo withBusinessService(s) created successfully

Body

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

Request

Response

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

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.

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

Response

ReponseInfo withBusinessService(s) created successfully

Body

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

Request

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

Response

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

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.

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).

assignesarray

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

Response

ReponseInfo with Workflow(s) created successfully

Body

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).

assignesarray

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

Request

Response

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

{
  "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"
        }
      ],
      "assignes": [],
      "nextActions": [
        "text"
      ],
      "currentStatus": "text",
      "previousStatus": "text"
    }
  ]
}