Reporting Service

Search API for report data

post

Get the report data based on the given search parameters.

Body

application/json

Request object to fetch the report data

tenantIdstringRequired

tenantId for which the report is needed

reportNamestringRequired

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

Responses

200

Successful response

application/json

Response object that has fetched report data

ttlinteger · int64Optional

UTC epoch upto which report data can be cached

reportDataobject[][]Optional

two dimensional array containing the report data

400

Invalid input.

application/json

post

/_get

HTTPcURLJavaScriptPython

POST /[module_base_path]/reports/v1/_get HTTP/1.1
Host: phoenix-qa.egovernments.org
Content-Type: application/json
Accept: */*
Content-Length: 231

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "tenantId": "text",
  "reportName": "text",
  "searchParams": [
    {
      "name": "text",
      "input": {}
    }
  ]
}

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "reportHeader": [
    {
      "name": "text",
      "label": "text",
      "type": "number",
      "defaultValue": {},
      "isMandatory": true,
      "showColumn": true
    }
  ],
  "ttl": 1,
  "reportData": [
    [
      {}
    ]
  ]
}