DIGIT-API's
  1. Report
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).
      • Process search of the applicaition
      • Get the list of workflow applications defined in the system.
      • Get the count of applications satisfying the given criteria
      • Get the nearing sla count of workflow applications defined in the system.
      • Get the list of status count workflow applications defined in the system.
    • 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.
      POST
  • 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
        POST
  • 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. Report

Search API for report data

Deprecated
POST
/_get
Report
Last modified:2024-04-19 09:51:28
Get the report data based on the given search parameters.

Request

Body Params application/json
Request object to fetch the report data
requestInfo
object 
RequestInfo
required
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.
apiId
string 
required
unique API ID
<= 128 characters
ver
string 
required
API version - for HTTP based request this will be same as used in path
<= 32 characters
ts
integer <int64>
required
time in epoch
action
string 
required
API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
<= 32 characters
did
string 
optional
Device ID from which the API is called
<= 1024 characters
key
string 
optional
API key (API key provided to the caller in case of server to server communication)
<= 256 characters
msgId
string 
required
Unique request message id from the caller
<= 256 characters
requesterId
string 
optional
UserId of the user calling
<= 256 characters
authToken
string 
optional
//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
userInfo
object 
User
optional
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.
tenantId
string 
required
tenantId for which the report is needed
reportName
string 
required
name of the report. A tenant specific report can be defined with tenantId as the prefix of the report name. So if the system finds two reports - report1 and mytenant.report1 and the tenantId for this request is mytenant then report definition mytenant.report1 will be picked
searchParams
array[object (SearchParam) {2}] 
optional
array of search parameters to use in report query
name
string 
required
column names of the report
input
object 
optional
User provided input of this parameter that will be used in query. Please note that value will be format checked against the value definition of this parameter in report definition. This field has been made an object so that multiple values from things like multivalue list can be accepted.
Example
{
    "requestInfo": {
        "apiId": "string",
        "ver": "string",
        "ts": 0,
        "action": "string",
        "did": "string",
        "key": "string",
        "msgId": "string",
        "requesterId": "string",
        "authToken": "string",
        "userInfo": {
            "tenantId": "string",
            "id": 0,
            "uuid": "string",
            "userName": "string",
            "mobileNumber": "string",
            "emailId": "string",
            "roles": [
                {
                    "tenantId": "string",
                    "id": "string",
                    "name": "string",
                    "description": "string"
                }
            ],
            "salutation": "string",
            "name": "string",
            "gender": "string",
            "alternateMobileNumber": "string",
            "altContactNumber": "string",
            "pan": "string",
            "aadhaarNumber": "string",
            "permanentAddress": "string",
            "permanentCity": "string",
            "permanentPincode": "string",
            "correspondenceCity": "string",
            "correspondencePincode": "string",
            "correspondenceAddress": "string",
            "active": true,
            "locale": "string",
            "type": "string",
            "accountLocked": true,
            "accountLockedDate": 0,
            "fatherOrHusbandName": "string",
            "relationship": "string",
            "signature": "string",
            "bloodGroup": "str",
            "photo": "string",
            "identificationMark": "string",
            "createdBy": 0,
            "password": "string",
            "otpReference": "string",
            "lastModifiedBy": 0,
            "createdDate": "2019-08-24",
            "lastModifiedDate": "2019-08-24",
            "dob": 0,
            "pwdExpiryDate": 0
        }
    },
    "tenantId": "string",
    "reportName": "string",
    "searchParams": [
        {
            "name": "string",
            "input": {}
        }
    ]
}

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 -g --request POST 'https://unified-dev.digit.org/[module_base_path]/reports/_get' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestInfo": {
        "apiId": "string",
        "ver": "string",
        "ts": 0,
        "action": "string",
        "did": "string",
        "key": "string",
        "msgId": "string",
        "requesterId": "string",
        "authToken": "string",
        "userInfo": {
            "tenantId": "string",
            "id": 0,
            "uuid": "string",
            "userName": "string",
            "mobileNumber": "string",
            "emailId": "string",
            "roles": [
                {
                    "tenantId": "string",
                    "id": "string",
                    "name": "string",
                    "description": "string"
                }
            ],
            "salutation": "string",
            "name": "string",
            "gender": "string",
            "alternateMobileNumber": "string",
            "altContactNumber": "string",
            "pan": "string",
            "aadhaarNumber": "string",
            "permanentAddress": "string",
            "permanentCity": "string",
            "permanentPincode": "string",
            "correspondenceCity": "string",
            "correspondencePincode": "string",
            "correspondenceAddress": "string",
            "active": true,
            "locale": "string",
            "type": "string",
            "accountLocked": true,
            "accountLockedDate": 0,
            "fatherOrHusbandName": "string",
            "relationship": "string",
            "signature": "string",
            "bloodGroup": "str",
            "photo": "string",
            "identificationMark": "string",
            "createdBy": 0,
            "password": "string",
            "otpReference": "string",
            "lastModifiedBy": 0,
            "createdDate": "2019-08-24",
            "lastModifiedDate": "2019-08-24",
            "dob": 0,
            "pwdExpiryDate": 0
        }
    },
    "tenantId": "string",
    "reportName": "string",
    "searchParams": [
        {
            "name": "string",
            "input": {}
        }
    ]
}'

Responses

🟢200Successful response
application/json
Body
Response object that has fetched report data
requestInfo
object (ResponseInfo) 
optional
ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.
apiId
string 
required
unique API ID
<= 128 characters
ver
string 
required
API version
<= 32 characters
ts
integer <int64>
required
response time in epoch
resMsgId
string 
optional
unique response message id (UUID) - will usually be the correlation id from the server
<= 256 characters
msgId
string 
optional
message id of the request
<= 256 characters
status
enum<string> 
required
status of request processing - to be enhanced in futuer to include INPROGRESS
Allowed values:
SUCCESSFULFAILED
reportHeader
array[object (ColumnDetail) {6}] 
optional
Array of report columns
name
string 
required
column names of the report
label
string 
optional
localization label for the column. In case label is not provided, name would be used as a label.
type
enum<string> 
required
column type to help the consumer. EPOCH means time being carried over in epoch format, while date means time in given display format
URL - will be used to indicate taht the column value is basically a URL to some other resource
Allowed values:
numberstringdatedatetimeepochurlsinglevaluelistmultivaluelist
defaultValue
object 
optional
any default value for the column if the column type is number, string, date, datetime, epoch or URL
collection contaning possible list value pairs for singlevaluelist and multivaluelist
the parameterized next click URL in case of drill down - the value inside {} needs to be replaced with the actual value of the column with that name
isMandatory
boolean 
optional
Default:
true
showColumn
boolean 
optional
whether to display the column value on the page, useful in cases like drill downs where teh value is needed for next search but is not meaningful to be shown to the user
Default:
true
ttl
integer <int64>
optional
UTC epoch upto which report data can be cached
reportData
array [array] 
optional
two dimensional array containing the report data
object 
optional
Example
{
    "requestInfo": {
        "apiId": "string",
        "ver": "string",
        "ts": 0,
        "resMsgId": "string",
        "msgId": "string",
        "status": "SUCCESSFUL"
    },
    "reportHeader": [
        {
            "name": "string",
            "label": "string",
            "type": "number",
            "defaultValue": {},
            "isMandatory": true,
            "showColumn": true
        }
    ],
    "ttl": 0,
    "reportData": [
        [
            {}
        ]
    ]
}
🟠400Invalid input.
Modified at 2024-04-19 09:51:28
Previous
Metadata API for report definition
Next
create OTP Configuration entry
Built with