Workflow

Workflow Engine APIs

APIs to create new, search, initiate workflows and transition states.

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

/process/_transition

Body

RequestInfoobject

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.

ProcessInstancesobject[]

Used for search result and create only

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-wf/process/_transition' \
  --header 'Content-Type: */*' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProcessInstances":[{"tenantId":"text","businessService":"text","businessId":"text","action":"text","assigner":{"userName":"text","name":"text","gender":"text","mobileNumber":"text","active":true,"locale":"text","type":"text","tenantId":"text","roles":[{"name":"text","tenantId":"text"}]},"auditDetails":{},"entity":{},"documents":[{"tenantId":"text","documentType":"text","fileStoreId":"text","auditDetails":{}}],"assignes":[{"userName":"text","name":"text","gender":"text","mobileNumber":"text","active":true,"locale":"text","type":"text","tenantId":"text","roles":[{"name":"text","tenantId":"text"}]}],"nextActions":[null]}]}'

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProcessInstances": [
    {
      "id": "text",
      "tenantId": "text",
      "businessService": "text",
      "businessId": "text",
      "action": "text",
      "state": "text",
      "comment": "text",
      "assigner": {
        "userName": "text",
        "name": "text",
        "gender": "text",
        "mobileNumber": "text",
        "active": true,
        "locale": "text",
        "type": "text",
        "tenantId": "text",
        "roles": [
          {
            "name": "text",
            "tenantId": "text"
          }
        ]
      },
      "sla": 1,
      "currentStatus": "text",
      "previousStatus": "text",
      "auditDetails": {},
      "entity": {},
      "documents": [
        {
          "tenantId": "text",
          "documentType": "text",
          "fileStoreId": "text",
          "auditDetails": {}
        }
      ],
      "assignes": [
        {
          "userName": "text",
          "name": "text",
          "gender": "text",
          "mobileNumber": "text",
          "active": true,
          "locale": "text",
          "type": "text",
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "tenantId": "text"
            }
          ]
        }
      ],
      "nextActions": [
        "text"
      ]
    }
  ]
}

ReponseInfo with Workflow(s) created successfully

Get the list of workflow applications defined in the system.

1. Search and get Application(s) based on defined search criteria.
2. In case multiple parameters are passed Application(s) will be searched as an AND combination of all the parameters.

post

/process/_search

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

idsinteger · int64[]

unique identifier of Application

businessServicestring · min: 2 · max: 64

Name of the workflow confguration.

moduleNamestring · min: 2 · max: 64

Module name to which workflow application belongs

businessIdsstring[]

The list of businessIds

assigneestring · min: 2 · max: 64

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

apiIdstring · max: 128required

unique API ID

verstring · max: 32required

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

tsinteger · int64required

time in epoch

actionstring · max: 32required

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

didstring · max: 1024

Device ID from which the API is called

keystring · max: 256

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

msgIdstring · max: 256required

Unique request message id from the caller

requesterIdstring · max: 256

UserId of the user calling

authTokenstring

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

userInfoobject

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

correlationIdstring

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-wf/process/_search?tenantId=text' \
  --header 'Content-Type: */*' \
  --data '{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProcessInstances": [
    {
      "id": "text",
      "tenantId": "text",
      "businessService": "text",
      "businessId": "text",
      "action": "text",
      "state": "text",
      "comment": "text",
      "assigner": {
        "userName": "text",
        "name": "text",
        "gender": "text",
        "mobileNumber": "text",
        "active": true,
        "locale": "text",
        "type": "text",
        "tenantId": "text",
        "roles": [
          {
            "name": "text",
            "tenantId": "text"
          }
        ]
      },
      "sla": 1,
      "currentStatus": "text",
      "previousStatus": "text",
      "auditDetails": {},
      "entity": {},
      "documents": [
        {
          "tenantId": "text",
          "documentType": "text",
          "fileStoreId": "text",
          "auditDetails": {}
        }
      ],
      "assignes": [
        {
          "userName": "text",
          "name": "text",
          "gender": "text",
          "mobileNumber": "text",
          "active": true,
          "locale": "text",
          "type": "text",
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "tenantId": "text"
            }
          ]
        }
      ],
      "nextActions": [
        "text"
      ]
    }
  ]
}

Application(s) Retrived Successfully

Get the count of applications satisfying the given criteria

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

post

/process/_count

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

idsinteger · int64[]

unique identifier of trade licence

businessServicestring · min: 2 · max: 64

Unique application number for a trade license application.

businessIdsinteger · int64[]

The list of businessIds

assigneestring · min: 2 · max: 64

The unique Old license number for a Trade license.

historyboolean

Boolean flag to return history of the workflow

Body

apiIdstring · max: 128required

unique API ID

verstring · max: 32required

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

tsinteger · int64required

time in epoch

actionstring · max: 32required

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

didstring · max: 1024

Device ID from which the API is called

keystring · max: 256

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

msgIdstring · max: 256required

Unique request message id from the caller

requesterIdstring · max: 256

UserId of the user calling

authTokenstring

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

userInfoobject

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

correlationIdstring

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-wf/process/_count?tenantId=text' \
  --header 'Content-Type: */*' \
  --data '{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProcessInstances": [
    {
      "id": "text",
      "tenantId": "text",
      "businessService": "text",
      "businessId": "text",
      "action": "text",
      "state": "text",
      "comment": "text",
      "assigner": {
        "userName": "text",
        "name": "text",
        "gender": "text",
        "mobileNumber": "text",
        "active": true,
        "locale": "text",
        "type": "text",
        "tenantId": "text",
        "roles": [
          {
            "name": "text",
            "tenantId": "text"
          }
        ]
      },
      "sla": 1,
      "currentStatus": "text",
      "previousStatus": "text",
      "auditDetails": {},
      "entity": {},
      "documents": [
        {
          "tenantId": "text",
          "documentType": "text",
          "fileStoreId": "text",
          "auditDetails": {}
        }
      ],
      "assignes": [
        {
          "userName": "text",
          "name": "text",
          "gender": "text",
          "mobileNumber": "text",
          "active": true,
          "locale": "text",
          "type": "text",
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "tenantId": "text"
            }
          ]
        }
      ],
      "nextActions": [
        "text"
      ]
    }
  ]
}

Trade License(s) Retrived Successfully

Get the nearing sla count of workflow applications defined in the system.

1. Search and get Application(s) based on defined search criteria.
2. In case multiple parameters are passed Application(s) will be searched as an AND combination of all the parameters.

post

/process/_nearingslacount

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

idsinteger · int64[]

unique identifier of Application

businessServicestring · min: 2 · max: 64

Name of the workflow confguration.

moduleNamestring · min: 2 · max: 64

Module name to which workflow application belongs

businessIdsstring[]

The list of businessIds

assigneestring · min: 2 · max: 64

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

apiIdstring · max: 128required

unique API ID

verstring · max: 32required

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

tsinteger · int64required

time in epoch

actionstring · max: 32required

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

didstring · max: 1024

Device ID from which the API is called

keystring · max: 256

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

msgIdstring · max: 256required

Unique request message id from the caller

requesterIdstring · max: 256

UserId of the user calling

authTokenstring

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

userInfoobject

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

correlationIdstring

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-wf/process/_nearingslacount?tenantId=text' \
  --header 'Content-Type: */*' \
  --data '{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Count": 1,
  "ProcessInstances": [
    {
      "ResponseInfo": {
        "apiId": "text",
        "ver": "text",
        "ts": 1,
        "resMsgId": "text",
        "msgId": "text",
        "status": "SUCCESSFUL"
      },
      "ProcessInstances": [
        {
          "id": "text",
          "tenantId": "text",
          "businessService": "text",
          "businessId": "text",
          "action": "text",
          "state": "text",
          "comment": "text",
          "assigner": {
            "userName": "text",
            "name": "text",
            "gender": "text",
            "mobileNumber": "text",
            "active": true,
            "locale": "text",
            "type": "text",
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "tenantId": "text"
              }
            ]
          },
          "sla": 1,
          "currentStatus": "text",
          "previousStatus": "text",
          "auditDetails": {},
          "entity": {},
          "documents": [
            {
              "tenantId": "text",
              "documentType": "text",
              "fileStoreId": "text",
              "auditDetails": {}
            }
          ],
          "assignes": [
            {
              "userName": "text",
              "name": "text",
              "gender": "text",
              "mobileNumber": "text",
              "active": true,
              "locale": "text",
              "type": "text",
              "tenantId": "text",
              "roles": [
                {
                  "name": "text",
                  "tenantId": "text"
                }
              ]
            }
          ],
          "nextActions": [
            "text"
          ]
        }
      ]
    }
  ]
}

Application(s) Retrived Successfully

Get the list of status count workflow applications defined in the system.

1. Search and get Application(s) based on defined search criteria.
2. In case multiple parameters are passed Application(s) will be searched as an AND combination of all the parameters.

post

/process/_statuscount

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

idsinteger · int64[]

unique identifier of Application

businessServicestring · min: 2 · max: 64

Name of the workflow confguration.

moduleNamestring · min: 2 · max: 64

Module name to which workflow application belongs

businessIdsstring[]

The list of businessIds

assigneestring · min: 2 · max: 64

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

RequestInfoobject

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.

ProcessInstanceSearchCriteriaobject

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-wf/process/_statuscount?tenantId=text' \
  --header 'Content-Type: */*' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProcessInstanceSearchCriteria":{"ids":[null]}}'

200

400

200

{
  "body": {},
  "statusCountValue": 1,
  "statusCode": "ACCEPTED",
  "result": [
    "text"
  ]
}

Application(s) Retrived Successfully

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

1. Search and get Application(s) based on defined search criteria.
2. In case multiple parameters are passed Application(s) will be searched as an AND combination of all the parameters.

post

/process/escalate/_search

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

idsinteger · int64[]

unique identifier of Application

businessServicestring · min: 2 · max: 64

Name of the workflow confguration.

moduleNamestring · min: 2 · max: 64

Module name to which workflow application belongs

businessIdsstring[]

The list of businessIds

assigneestring · min: 2 · max: 64

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

apiIdstring · max: 128required

unique API ID

verstring · max: 32required

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

tsinteger · int64required

time in epoch

actionstring · max: 32required

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

didstring · max: 1024

Device ID from which the API is called

keystring · max: 256

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

msgIdstring · max: 256required

Unique request message id from the caller

requesterIdstring · max: 256

UserId of the user calling

authTokenstring

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

userInfoobject

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

correlationIdstring

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-wf/process/escalate/_search?tenantId=text' \
  --header 'Content-Type: */*' \
  --data '{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProcessInstances": [
    {
      "id": "text",
      "tenantId": "text",
      "businessService": "text",
      "businessId": "text",
      "action": "text",
      "state": "text",
      "comment": "text",
      "assigner": {
        "userName": "text",
        "name": "text",
        "gender": "text",
        "mobileNumber": "text",
        "active": true,
        "locale": "text",
        "type": "text",
        "tenantId": "text",
        "roles": [
          {
            "name": "text",
            "tenantId": "text"
          }
        ]
      },
      "sla": 1,
      "currentStatus": "text",
      "previousStatus": "text",
      "auditDetails": {},
      "entity": {},
      "documents": [
        {
          "tenantId": "text",
          "documentType": "text",
          "fileStoreId": "text",
          "auditDetails": {}
        }
      ],
      "assignes": [
        {
          "userName": "text",
          "name": "text",
          "gender": "text",
          "mobileNumber": "text",
          "active": true,
          "locale": "text",
          "type": "text",
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "tenantId": "text"
            }
          ]
        }
      ],
      "nextActions": [
        "text"
      ]
    }
  ]
}

Application(s) Retrived Successfully

Get the list of workflow applications defined in the system.

1. Search and get Application(s) based on defined search criteria.
2. In case multiple parameters are passed Application(s) will be searched as an AND combination of all the parameters.

post

/auto/{businessService}/_escalate

Path parameters

businessServicestring · min: 2 · max: 64required

Name of the workflow confguration.

Query parameters

tenantIdstring · varcharrequired

Unique id for a tenant.

idsinteger · int64[]

unique identifier of Application

moduleNamestring · min: 2 · max: 64

Module name to which workflow application belongs

businessIdsstring[]

The list of businessIds

assigneestring · min: 2 · max: 64

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

apiIdstring · max: 128required

unique API ID

verstring · max: 32required

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

tsinteger · int64required

time in epoch

actionstring · max: 32required

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

didstring · max: 1024

Device ID from which the API is called

keystring · max: 256

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

msgIdstring · max: 256required

Unique request message id from the caller

requesterIdstring · max: 256

UserId of the user calling

authTokenstring

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

userInfoobject

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

correlationIdstring

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-wf/auto/{businessService}/_escalate?tenantId=text' \
  --header 'Content-Type: */*' \
  --data '{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProcessInstances": [
    {
      "id": "text",
      "tenantId": "text",
      "businessService": "text",
      "businessId": "text",
      "action": "text",
      "state": "text",
      "comment": "text",
      "assigner": {
        "userName": "text",
        "name": "text",
        "gender": "text",
        "mobileNumber": "text",
        "active": true,
        "locale": "text",
        "type": "text",
        "tenantId": "text",
        "roles": [
          {
            "name": "text",
            "tenantId": "text"
          }
        ]
      },
      "sla": 1,
      "currentStatus": "text",
      "previousStatus": "text",
      "auditDetails": {},
      "entity": {},
      "documents": [
        {
          "tenantId": "text",
          "documentType": "text",
          "fileStoreId": "text",
          "auditDetails": {}
        }
      ],
      "assignes": [
        {
          "userName": "text",
          "name": "text",
          "gender": "text",
          "mobileNumber": "text",
          "active": true,
          "locale": "text",
          "type": "text",
          "tenantId": "text",
          "roles": [
            {
              "name": "text",
              "tenantId": "text"
            }
          ]
        }
      ],
      "nextActions": [
        "text"
      ]
    }
  ]
}

Application(s) Retrived Successfully

Create new v2 BuinessService.

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

Following Conditions are applied -

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

post

/businessservice/v2/_create

Body

RequestInfoobject

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.

BusinessServiceobject[]

Used for search result and create only

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-wf/businessservice/v2/_create' \
  --header 'Content-Type: */*' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"BusinessService":[{"tenantId":"text","businessService":"text","auditDetails":{},"states":[{"auditDetails":{},"actions":[{"auditDetails":{},"roles":[null]}]}]}]}'

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BusinessService": [
    {
      "tenantId": "text",
      "uuid": "text",
      "businessService": "text",
      "getUri": "text",
      "postUri": "text",
      "auditDetails": {},
      "states": [
        {
          "auditDetails": {},
          "actions": [
            {
              "auditDetails": {},
              "roles": [
                null
              ]
            }
          ]
        }
      ]
    }
  ]
}

ReponseInfo withBusinessService(s) created successfully

Updates a existing v2 BuinessService.

Can be used only to add new state or action in the workflow. Can update any existing field. Removing of any state is not allowed as applications in that state will be in invalid state

Following Conditions are applied -

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

post

/businessservice/v2/_update

Body

RequestInfoobject

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.

BusinessServiceobject[]

Used for search result and create only

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-wf/businessservice/v2/_update' \
  --header 'Content-Type: */*' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"BusinessService":[{"tenantId":"text","businessService":"text","auditDetails":{},"states":[{"auditDetails":{},"actions":[{"auditDetails":{},"roles":[null]}]}]}]}'

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BusinessService": [
    {
      "tenantId": "text",
      "uuid": "text",
      "businessService": "text",
      "getUri": "text",
      "postUri": "text",
      "auditDetails": {},
      "states": [
        {
          "auditDetails": {},
          "actions": [
            {
              "auditDetails": {},
              "roles": [
                null
              ]
            }
          ]
        }
      ]
    }
  ]
}

ReponseInfo withBusinessService(s) created successfully

Get the list of v2 BusinessServices defined in the system.

1. Search and get BusinessServices(s) based on defined search criteria.
2. In case multiple parameters are passed BusinessService(s) will be searched as an AND combination of all the parameters.

post

/businessservice/v2/_search

Query parameters

businessServicesinteger · int64[]

BusinessService code of the businessService

tenantIdstring · varcharrequired

Unique id for a tenant.

Body

apiIdstring · max: 128required

unique API ID

verstring · max: 32required

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

tsinteger · int64required

time in epoch

actionstring · max: 32required

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

didstring · max: 1024

Device ID from which the API is called

keystring · max: 256

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

msgIdstring · max: 256required

Unique request message id from the caller

requesterIdstring · max: 256

UserId of the user calling

authTokenstring

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

userInfoobject

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

correlationIdstring

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-wf/businessservice/v2/_search?tenantId=text' \
  --header 'Content-Type: */*' \
  --data '{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BusinessService": [
    {
      "tenantId": "text",
      "uuid": "text",
      "businessService": "text",
      "getUri": "text",
      "postUri": "text",
      "auditDetails": {},
      "states": [
        {
          "auditDetails": {},
          "actions": [
            {
              "auditDetails": {},
              "roles": [
                null
              ]
            }
          ]
        }
      ]
    }
  ]
}

Trade License(s) Retrived Successfully

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

/businessservice/_create

Body

RequestInfoobject

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.

BusinessServiceobject[]

Used for search result and create only

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-wf/businessservice/_create' \
  --header 'Content-Type: */*' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"BusinessService":[{"tenantId":"text","businessService":"text","auditDetails":{},"states":[{"auditDetails":{},"actions":[{"auditDetails":{},"roles":[null]}]}]}]}'

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BusinessService": [
    {
      "tenantId": "text",
      "uuid": "text",
      "businessService": "text",
      "getUri": "text",
      "postUri": "text",
      "auditDetails": {},
      "states": [
        {
          "auditDetails": {},
          "actions": [
            {
              "auditDetails": {},
              "roles": [
                null
              ]
            }
          ]
        }
      ]
    }
  ]
}

ReponseInfo withBusinessService(s) created successfully

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

/businessservice/_update

Body

RequestInfoobject

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.

BusinessServiceobject[]

Used for search result and create only

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-wf/businessservice/_update' \
  --header 'Content-Type: */*' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"BusinessService":[{"tenantId":"text","businessService":"text","auditDetails":{},"states":[{"auditDetails":{},"actions":[{"auditDetails":{},"roles":[null]}]}]}]}'

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BusinessService": [
    {
      "tenantId": "text",
      "uuid": "text",
      "businessService": "text",
      "getUri": "text",
      "postUri": "text",
      "auditDetails": {},
      "states": [
        {
          "auditDetails": {},
          "actions": [
            {
              "auditDetails": {},
              "roles": [
                null
              ]
            }
          ]
        }
      ]
    }
  ]
}

ReponseInfo withBusinessService(s) created successfully

Get the list of BusinessServices defined in the system.

1. Search and get BusinessServices(s) based on defined search criteria.
2. In case multiple parameters are passed BusinessService(s) will be searched as an AND combination of all the parameters.

post

/businessservice/_search

Query parameters

businessServicesinteger · int64[]

BusinessService code of the businessService

tenantIdstring · varcharrequired

Unique id for a tenant.

Body

apiIdstring · max: 128required

unique API ID

verstring · max: 32required

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

tsinteger · int64required

time in epoch

actionstring · max: 32required

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

didstring · max: 1024

Device ID from which the API is called

keystring · max: 256

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

msgIdstring · max: 256required

Unique request message id from the caller

requesterIdstring · max: 256

UserId of the user calling

authTokenstring

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

userInfoobject

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

correlationIdstring

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/egov-wf/businessservice/_search?tenantId=text' \
  --header 'Content-Type: */*' \
  --data '{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "BusinessService": [
    {
      "tenantId": "text",
      "uuid": "text",
      "businessService": "text",
      "getUri": "text",
      "postUri": "text",
      "auditDetails": {},
      "states": [
        {
          "auditDetails": {},
          "actions": [
            {
              "auditDetails": {},
              "roles": [
                null
              ]
            }
          ]
        }
      ]
    }
  ]
}

Trade License(s) Retrived Successfully