Inbox

Employee Inbox APIs

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

PreviousID Generation NextIndexer

Last updated 1 year ago

Was this helpful?

search

post

/inbox/v1/_search

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.

inboxobject

Search criteria

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/inbox/v1/_search' \
  --header 'Content-Type: application/json' \
  --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"}]}]}},"inbox":{"moduleSearchCriteria":{},"processSearchCriteria":{}}}'

200

201

401

403

404

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "statusMap": {},
  "totalCount": "text",
  "items": [
    {
      "businessObject": "text",
      "ProcessInstance": {
        "id": "text",
        "tenantId": "text",
        "businessService": "text",
        "businessId": "text",
        "action": "text",
        "state": "text",
        "comment": "text",
        "assigner": {
          "id": 1,
          "userName": "text",
          "password": "super-secret",
          "salutation": "text",
          "name": "text",
          "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-02-22",
          "pwdExpiryDate": "2025-02-22",
          "locale": "text",
          "signature": "text",
          "accountLocked": true,
          "fatherOrHusbandName": "text",
          "identificationMark": "text",
          "photo": "text",
          "createdBy": 1,
          "createdDate": "2025-02-22",
          "lastModifiedBy": 1,
          "lastModifiedDate": "2025-02-22",
          "otpReference": "text",
          "tenantId": "text",
          "roles": [
            {
              "id": 1,
              "name": "text",
              "code": "text",
              "description": "text",
              "createdBy": 1,
              "createdDate": "2025-02-22",
              "lastModifiedBy": 1,
              "lastModifiedDate": "2025-02-22",
              "tenantId": "text"
            }
          ],
          "gender": [
            "MALE"
          ],
          "type": [
            "EMPLOYEE"
          ],
          "bloodGroup": [
            "A+"
          ]
        },
        "sla": 1,
        "currentStatus": "text",
        "previousStatus": "text",
        "entity": {},
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        },
        "documents": [
          {
            "id": "text",
            "tenantId": "text",
            "documentType": "text",
            "fileStoreId": "text",
            "documentUid": "text",
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text",
              "createdTime": 1,
              "lastModifiedTime": 1
            }
          }
        ],
        "assignes": [
          {
            "id": 1,
            "userName": "text",
            "password": "super-secret",
            "salutation": "text",
            "name": "text",
            "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-02-22",
            "pwdExpiryDate": "2025-02-22",
            "locale": "text",
            "signature": "text",
            "accountLocked": true,
            "fatherOrHusbandName": "text",
            "identificationMark": "text",
            "photo": "text",
            "createdBy": 1,
            "createdDate": "2025-02-22",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-02-22",
            "otpReference": "text",
            "tenantId": "text",
            "roles": [
              {
                "id": 1,
                "name": "text",
                "code": "text",
                "description": "text",
                "createdBy": 1,
                "createdDate": "2025-02-22",
                "lastModifiedBy": 1,
                "lastModifiedDate": "2025-02-22",
                "tenantId": "text"
              }
            ],
            "gender": [
              "MALE"
            ],
            "type": [
              "EMPLOYEE"
            ],
            "bloodGroup": [
              "A+"
            ]
          }
        ],
        "nextActions": [
          "text"
        ]
      }
    }
  ]
}

getChartV2

post

/inbox/v1/dss/_search

Body

modulestring

tenantIdstring

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/inbox/v1/dss/_search' \
  --header 'Content-Type: application/json'

200

201

401

403

404

{
  "ANY_ADDITIONAL_PROPERTY": 1
}

elasticSearch

post

/inbox/v1/elastic/_search

Body

InboxElasticSearchCriteriaInboxElasticSearchCriteria

RequestInfoRequestInfo

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/inbox/v1/elastic/_search' \
  --header 'Content-Type: application/json' \
  --data '{"InboxElasticSearchCriteria":{"indexKey":"text","tenantId":"text"},"RequestInfo":{"plainAccessRequest":{"plainRequestFields":[null]},"userInfo":{"roles":[{}]}}}'

200

201

401

403

404

{
  "ANY_ADDITIONAL_PROPERTY": {}
}