Reporting Service

Search API for report data

Get the report data based on the given search parameters.

post

/_get

Body

requestInfoobjectrequired

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.

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

searchParamsall of[]

array of search parameters to use in report query

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://phoenix-qa.egovernments.org/[module_base_path]/reports/v1/_get' \
  --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"}]}]}},"tenantId":"text","reportName":"text","searchParams":[{"name":"text","input":{}}]}'

200

400

200

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

Successful response