Reporting Service

Search API for report data

post

Get the report data based on the given search parameters.

Body

all ofoptional

Request object to fetch the report data

Request object to fetch the report data

Responses

application/json

application/json

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",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "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"
  },
  "reportHeader": [
    {
      "name": "text",
      "label": "text",
      "type": "number",
      "defaultValue": {},
      "isMandatory": true,
      "showColumn": true
    }
  ],
  "ttl": 1,
  "reportData": [
    [
      {}
    ]
  ]
}

Successful response