Inbox

Employee Inbox APIs

API specs that route applications to employee inbox assigned for action.

search

post

Body

Response of the FSM

RequestInfoobjectOptional

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.

inboxobjectOptional

Search criteria

Responses

*/*

objectOptional

Response of the FSM

post

HTTPcURLJavaScriptPython

POST /inbox/v1/_search HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 251

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "inbox": {
    "tenantId": "text",
    "processSearchCriteria": {},
    "moduleSearchCriteria": {},
    "offset": 1,
    "limit": 1
  }
}

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "statusMap": {},
  "items": [
    {
      "businessObject": "text",
      "ProcessInstance": {
        "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",
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text",
              "createdTime": 1,
              "lastModifiedTime": 1
            }
          }
        ],
        "assigner": {
          "id": 1,
          "userName": "text",
          "password": "password",
          "salutation": "text",
          "name": "text",
          "gender": [
            "MALE"
          ],
          "mobileNumber": "text",
          "emailId": "text",
          "altContactNumber": "text",
          "pan": "text",
          "aadhaarNumber": "text",
          "permanentAddress": "text",
          "permanentCity": "text",
          "permanentPincode": "text",
          "correspondenceCity": "text",
          "correspondencePincode": "text",
          "correspondenceAddress": "text",
          "active": true,
          "dob": "2025-04-19",
          "pwdExpiryDate": "2025-04-19",
          "locale": "text",
          "type": [
            "EMPLOYEE"
          ],
          "signature": "text",
          "accountLocked": true,
          "roles": [
            {
              "id": 1,
              "name": "text",
              "code": "text",
              "description": "text",
              "createdBy": 1,
              "createdDate": "2025-04-19",
              "lastModifiedBy": 1,
              "lastModifiedDate": "2025-04-19",
              "tenantId": "text"
            }
          ],
          "fatherOrHusbandName": "text",
          "bloodGroup": [
            "A+"
          ],
          "identificationMark": "text",
          "photo": "text",
          "createdBy": 1,
          "createdDate": "2025-04-19",
          "lastModifiedBy": 1,
          "lastModifiedDate": "2025-04-19",
          "otpReference": "text",
          "tenantId": "text"
        },
        "assignes": [
          {
            "id": 1,
            "userName": "text",
            "password": "password",
            "salutation": "text",
            "name": "text",
            "gender": [
              "MALE"
            ],
            "mobileNumber": "text",
            "emailId": "text",
            "altContactNumber": "text",
            "pan": "text",
            "aadhaarNumber": "text",
            "permanentAddress": "text",
            "permanentCity": "text",
            "permanentPincode": "text",
            "correspondenceCity": "text",
            "correspondencePincode": "text",
            "correspondenceAddress": "text",
            "active": true,
            "dob": "2025-04-19",
            "pwdExpiryDate": "2025-04-19",
            "locale": "text",
            "type": [
              "EMPLOYEE"
            ],
            "signature": "text",
            "accountLocked": true,
            "roles": [
              {
                "id": 1,
                "name": "text",
                "code": "text",
                "description": "text",
                "createdBy": 1,
                "createdDate": "2025-04-19",
                "lastModifiedBy": 1,
                "lastModifiedDate": "2025-04-19",
                "tenantId": "text"
              }
            ],
            "fatherOrHusbandName": "text",
            "bloodGroup": [
              "A+"
            ],
            "identificationMark": "text",
            "photo": "text",
            "createdBy": 1,
            "createdDate": "2025-04-19",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-04-19",
            "otpReference": "text",
            "tenantId": "text"
          }
        ],
        "nextActions": [
          "text"
        ],
        "sla": 1,
        "currentStatus": "text",
        "previousStatus": "text",
        "entity": {},
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    }
  ],
  "totalCount": "text"
}

getChartV2

post

Body

modulestringOptional

tenantIdstringOptional

Responses

*/*

objectOptional

post

HTTPcURLJavaScriptPython

POST /inbox/v1/dss/_search HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "module": "text",
  "tenantId": "text"
}

{
  "ANY_ADDITIONAL_PROPERTY": 1
}

elasticSearch

post

Body

InboxElasticSearchCriteriaobjectOptional

RequestInfoobjectOptional

Responses

*/*

objectOptional

post

HTTPcURLJavaScriptPython

POST /inbox/v1/elastic/_search HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 555

{
  "InboxElasticSearchCriteria": {
    "fromDate": 1,
    "indexKey": "text",
    "limit": 1,
    "offset": 1,
    "sortOrder": "text",
    "tenantId": "text",
    "toDate": 1
  },
  "RequestInfo": {
    "action": "text",
    "apiId": "text",
    "authToken": "text",
    "correlationId": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "plainAccessRequest": {
      "plainRequestFields": [
        "text"
      ],
      "recordId": "text"
    },
    "ts": 1,
    "userInfo": {
      "emailId": "text",
      "id": 1,
      "mobileNumber": "text",
      "name": "text",
      "roles": [
        {
          "code": "text",
          "id": 1,
          "name": "text",
          "tenantId": "text"
        }
      ],
      "tenantId": "text",
      "type": "text",
      "userName": "text",
      "uuid": "text"
    },
    "ver": "text"
  }
}

{
  "ANY_ADDITIONAL_PROPERTY": {}
}