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

POST/process/_transition

Last modified: 8 months ago

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.

Request

Header Params

Content-Type

string

optional

Example:

application/json

Body Params text/plain

Example:{ "RequestInfo": { "apiId": null, "ver": null, "ts": null, "action": "POST", "did": null, "key": null, "msgId": "5bfa85e7-dfa1-47c8-98b2-747bf552be86", "authToken": "50b80fa6-bec2-438e-a168-ce5ad53770b5" }, "ProcessInstances": [ { "tenantId": "pg", "businessService": "WaterManegament3", "businessId": "pgrmnkm001x1iMmmA", "action": "APPLY", "comment": null, "assignee": null, "previousStatus": null } ] }

Request samples

Responses

ReponseInfo with Workflow(s) created successfully(201)

Workflow(s) creation failed(400)

ReponseInfo with Workflow(s) created successfully

HTTP Code: 201

Content Type : JSONapplication/json

ResponseInfo

object

optional

ProcessInstances

array[object (ProcessInstance) {20}]

optional

Used for search result and create only

string

read-onlyoptional

Unique process instance id (UUID)

>= 2 characters<= 64 characters

tenantId

string

required

Unique Identifier of ULB

>= 2 characters<= 128 characters

businessService

string

required

Business service key.

>= 2 characters<= 128 characters

businessId

string

required

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

>= 2 characters<= 128 characters

action

string

required

Actions are define for each business service.

>= 2 characters<= 128 characters

moduleName

string

required

Module to which process instance belongs to.

>= 2 characters<= 64 characters

state

string

read-onlyoptional

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

>= 2 characters<= 64 characters

comment

string

optional

consumer can pass the comment on each action.

>= 2 characters<= 64 characters

documents

array[object (Document) {6}]

optional

Documents can be attached with each of the action.

assigner

object

optional

assignes

array [object]

optional

nextActions

array[string]

read-onlyoptional

Wf will return next possible action based on .

stateSla

integer <int64>

optional

Date from when license is valid as epoch.

businesssServiceSla

integer <int64>

optional

Date from when license is valid as epoch.

currentStatus

string

optional

Status after action performed

previousStatus

string

optional

Status before action performed

<= 128 characters

entity

object

optional

rating

integer

optional

Rating for current process instance

>= 1<= 5

escalated

boolean

optional

auditDetails

object

optional

totalCount

integer

optional

{
  "ResponseInfo": {},
  "ProcessInstances": [
    {
      "id": "string",
      "tenantId": "string",
      "businessService": "string",
      "businessId": "string",
      "action": "string",
      "moduleName": "string",
      "state": "string",
      "comment": "string",
      "documents": [
        {
          "id": "string",
          "tenantId": "string",
          "documentType": "string",
          "fileStoreId": "string",
          "documentUid": "string",
          "auditDetails": {}
        }
      ],
      "assigner": {},
      "assignes": [
        {}
      ],
      "nextActions": [
        "string"
      ],
      "stateSla": 0,
      "businesssServiceSla": 0,
      "currentStatus": "string",
      "previousStatus": "string",
      "entity": {},
      "rating": 1,
      "escalated": true,
      "auditDetails": {}
    }
  ],
  "totalCount": 0
}

Last modified: 8 months ago