Workflow Service

Create new BuinessService.

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

Following Conditions are applied -

1. All actions have valid next state i.e next state should be present in the system
2. uuids will be auto generated and assigned to all sub objects
3. For end states isTerminateState should be true

POST/egov-wf/businessservice/_create

Body

application/json

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

BusinessServicearray of BusinessService (object)

Used for search result and create only

Response

201400

ReponseInfo withBusinessService(s) created successfully

Body

*/*

BusinessServicearray of BusinessService (object)

Used for search result and create only

Request

JavaScriptCurlPython

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

Response

201

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

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

POST/egov-wf/businessservice/_update

Body

application/json

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

BusinessServicearray of BusinessService (object)

Used for search result and create only

Response

201400

ReponseInfo withBusinessService(s) created successfully

Body

*/*

BusinessServicearray of BusinessService (object)

Used for search result and create only

Request

JavaScriptCurlPython

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

Response

201

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

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

Following Conditions are applied -

1. Valid action is send according to workflow configuration defined
2. supportDocuments to perform workflow action will created. In case of not attaching the Mandatory Supported Documents creation of workflow Fails.
3. Application will move to next state if valid action is passes.

POST/egov-wf/process/_transition

Body

application/json

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

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

Response

201400

ReponseInfo with Workflow(s) created successfully

Body

*/*

ProcessInstancesarray of ProcessInstance (object)

Used for search result and create only

Request

JavaScriptCurlPython

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

Response

201

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