DIGIT-API's
  1. WorkFlow
DIGIT-API's
  • Using DIGIT-PLAYGROUND
  • User
    • Manage
      • Create User
      • Search All Users
      • Search Active Users
      • Create User Without OTP Validation
      • Update User Without OTP Validation
      • Get User
      • Update Profile
    • Authenticate
      • Logout
      • Reset Password
      • Login
  • Master Data V1
    • List
      POST
    • Search
      POST
  • Master Data V2
    • Create Schema
      • Create Schema
    • Search Schema
      • Seach Schema
    • Add Data
      • Create
    • Seach Data
      • Seach Data
    • Update data
      • Updata
  • Access-control
    • Action
      • Authorize User
      • Get the list of actions based on either roles or features.
      • Create a new action.
      • Update existing action(s).
      • getAllMDMSActions
      • Validate a particular action for a given tenant and roles of the tenant
    • Role
      • Get the list of roles based on role codes.
      • Create a new role.
      • Update existing role(s).
    • Role-Action
      • Create mapping for role and action(s).
  • Workflow-v2
    • WorkFlow
      • Create new workflow entry for a given application number(businessId).
        POST
      • Process search of the applicaition
        POST
      • Get the list of workflow applications defined in the system.
        POST
      • Get the count of applications satisfying the given criteria
        POST
      • Get the nearing sla count of workflow applications defined in the system.
        POST
      • Get the list of status count workflow applications defined in the system.
        POST
    • Escalate
      • Get the list of escalate workflow applications defined in the system.
      • Get the list of workflow applications defined in the system.
    • BusinessServiceV2
      • Create new v2 BuinessService.
      • Updates a existing v2 BuinessService.
      • Get the list of v2 BusinessServices defined in the system.
    • BusinessService
      • Create new BuinessService.
      • Updates a existing BuinessService.
      • Get the list of BusinessServices defined in the system.
  • Filestore
    • Upload File
      • Uploads different kinds of files to server.
    • Search
      • Search file url based on tenantid and filestoreid.
      • Search file url based on tenantid and tag name.
      • Get metadata of file based on tenantId and filestoreId.
      • Search file url based on tenantid and filestoreid.
  • Idgen
    • IdGeneration Controller
    • Create new id.
  • Location
    • Boundary
      • Search Location
      • It Will provide the List of boundaries based on search criteria Like "Srikakulam Municipality","Zone-1","Zone-2" etc.
    • Geography
      • Handles all requests related to Geographical boundaries by providing appropriate GeoJson and other associated data
    • Tenant
      • Resolves a given latitude / longitude to the corresponding tenant Id
  • Enc-Service
    • Crypto
      • Encrypts the given input value/s OR values of the object.
      • Decrypts the given input value/s OR values of the object.
      • Provide signature for a given value.
      • Check if the signature is correct for the provided value.
      • Deactivate the keys for the given tenant and generate new keys. It will deactivate both symmetric and asymmetric keys for the provided tenant.
      • cryptoRotateAllKeys
  • PG-Service
    • transactions-api-controller
      • transactionsV1AvailableGatewaysPost
      • transactionsV1CreatePost
      • transactionsV1SearchPost
      • transactionsV1UpdatePost
  • URL-Shortening
    • egov-url-shortening service endpoints
      • shorten given url
      • redirects user to orignal url identified by id
  • Indexer
    • egov-indexer service
      • This endpoint is used to start legacy index job to reindex records from DB. The data is fetched from DB by calling api mentioned in request in batches. The is useful when some record is present in DB but missing on index.
      • This endpoint is used to start indexing job to reindex records from one index to another index.
      • This endpoint is used to index one record on a index. The information to pick correct config is provided with the data to be indexed.
      • Index data in row
  • PDF-Service
    • PDF-Service endpoints
      • Generate PDF and store output pdfs to filestore and return their filestoreids. The information is also saved into DB so that using _search endpoint we can retrieve already generated pdfs.
      • Generates pdf without storing any information on filestore or in DB. The generated pdf would be returned as binary response
      • Get filestoreids and other information about already generated pdf by searching on jobid or entityid with other optional search parameters
  • Report
    • Report Meta
      • createv1
      • getReportDatav1
      • Metadata API for report definition
    • Report
      • Search API for report data
  • eGov-OTP
    • OTPConfig
      • create OTP Configuration entry
      • validate OTP Configuration entry
      • search OTP Configuration entry using uuid
  • User-OTP
    • user otp send
  • Localization
    • Create Message
      • create massage
    • Fetch Message
      • fetch message
    • Update message
      • update message
    • Delete message
      • delete mesage
    • Upsert message
      • upsert message
  • Service Request
    • Service Defination Create
      • Create service defination
    • Service Defination search
      • Search service defination
    • Service create
      • service create
    • Service Search
      • Service search
  • Audit Service
  1. WorkFlow

Get the list of workflow applications defined in the system.

POST
/process/_search
WorkFlow
Last modified:2024-05-22 10:26:07
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.

Request

Query Params
tenantId
string <varchar>
required
Unique id for a tenant.
Example:
pg
status
string 
optional
status of Application
ids
string 
optional
Unique id of Application
businessService
string 
optional
Name of the workflow confguration.
>= 2 characters<= 64 characters
moduleName
string 
optional
Module name to which workflow application belongs
>= 2 characters<= 64 characters
businessIds
string 
optional
The list of businessIds
Example:
pgrmnkm001x1iMmm
assignee
string 
optional
The unique Old license number for a Application.
>= 2 characters<= 64 characters
history
boolean 
optional
Boolean flag to return history of the workflow
Example:
true
limit
integer 
optional
Number of records to be returned
offset
integer 
optional
Starting offset for returning search response
fromDate
integer 
optional
Number of records to be returned
toDate
integer 
optional
Number of records to be returned
Header Params
Content-Type
string 
optional
Example:
application/json
Body Params text/plain
Example
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" } }

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://unified-dev.digit.org/egov-workflow-v2/egov-wf/process/_search?tenantId=pg&status&ids&businessService&moduleName&businessIds=pgrmnkm001x1iMmm&assignee&history=true&limit&offset&fromDate&toDate' \
--header 'Content-Type: application/json' \
--data-raw '{"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"
    }
    }'

Responses

🟢200Application(s) Retrived Successfully
application/json
Body
ResponseInfo
object 
optional
ProcessInstances
array[object (ProcessInstance) {20}] 
optional
Used for search result and create only
id
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
Example
{
  "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
}
🟠400Invalid input.
Modified at 2024-05-22 10:26:07
Previous
Process search of the applicaition
Next
Get the count of applications satisfying the given criteria
Built with