Versions Compared

Old Version 7

changes.mady.by.user Radek Micka

Saved on

compared with

New Version 8

changes.mady.by.user Radek Micka

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languageen

/api/reports/views/:id/table/json

This method returns table in JSON format.

Resource Information

Resource URL

https://service.belladati.com/api/reports/views/:id/table/json

HTTP Method

POST

Request Parameters

Parameters

Detail

Example

id

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

123
drilldownConfig

(Optional) Replaces the table drill-down with custom configuration. Both horizontal and vertical drill-down configuration can be replaced. Each configuration is an array with the following elements:

Name

Description

dataSetDrilldownAttributeCode of the attribute (e.g. L_CITY)
dataSetDrilldownAttributeSubset(Optional) ID of the used subset
hideDataSetCustomMembers

(Optional), defines whether custom members should be hidden, available values:

  • true
  • false



Code Block
{
	"horizontal":[
		{
			"dataSetDrilldownAttribute":"L_PRODUCT_TYPE"
		},
		{
			"dataSetDrilldownAttribute":"L_PRODUCT",
			"hideDataSetCustomMembers": true
		}
	],
	"vertical":[
		{
			"dataSetDrilldownAttribute":"L_DATE",
	 		"dataSetDrilldownAttributeSubset":"0EE39yrVHY"
		}
	]
}


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:

Code Block
curl -H "Authorization: OAuth realm=\"https://service.belladati.com/\", oauth_consumer_key=\"myConsumer\", oauth_token=\"mh7an9dkrg59\", oauth_timestamp=\"135131231\", oauth_nonce=\"randomString\"" https://service.belladati.com/api/reports/views/1234/table/json

The JSON format response:

Code Block
{ 
  "rowsCount" : 5, 
  "name" : "My Table Name", 
  "header" : [ 
    [ 
      { 
        "value" : "", 
        "type" : "header" 
      } 
    ], 
    [ 
      { 
        "value" : "", 
        "type" : "header" 
      } 
    ] 
  ], 
  "body" : [ 
    [ 
      { 
        "value" : "Value", 
        "type" : "header" 
      }, 
      { 
        "style" : " color:rgb(77, 77, 77) !important ; background-color:rgb(237, 237, 237); ", 
        "value" : "1,033,054,533,155" 
      } 
    ], 
    [ 
      { 
        "value" : "Value Footnotes", 
        "type" : "header" 
      }, 
      { 
        "style" : " color:rgb(77, 77, 77) !important ; background-color:rgb(237, 237, 237); ", 
        "value" : "1" 
      } 
    ], 
    [ 
      { 
        "value" : "B", 
        "type" : "header" 
      }, 
      { 
        "style" : " color:rgb(77, 77, 77) !important ; background-color:rgb(237, 237, 237); ", 
        "value" : "5" 
      } 
    ]
  ]
}

Next steps

List siblings

Sv translation
languageja

Sv translation
languagezh

Sv translation
languagecs

Sv translation
languagesk