Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Request Parameters

Parameters

Detail

Example

id

ID of the table. This ID is part of the /api/reports/:id response. Example:

123

filter

(Optional) Filter applied to the table, with following structure:

Name
Description
drilldown

Drilldown defined with attribute code and following structure:

Name
Description
opFilter operation type - please see list of supported values.
value/values(Optional) Depends on selected "op". Contains value or values for filter.


 
Example:

Code Block
{
  "drilldown": {
      "L_COUNTRY_OR_AREA": { "op": "EQ", "value": "Slovakia"},
      "L_TYPE": { "op": "IN", "values": [ "Type 1", "Type 2", "Type 3" ]},
      "L_DATE":{"op":"NOT_NULL"}
  }
}

Response Structure

Code Block
{ 
  "rowsCount" : ..., 
  "name" : ..., 
  "header" : [ ], 
  "body" : [ ]
}

JSON response contains elements with following definition:

NameDescription
rowsCountTotal number of rows including headers and data
nameTable view name
headerArray containing header elements
bodyArray containing data elements

Sample request/response

Using curl:

...