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

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://unified-dev.digit.org/[module_base_path]/reports/_get' \
--header 'Content-Type: application/json' \
--data-raw ''

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

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

Metadata API for report definition

create OTP Configuration entry