Versions Compared

Old Version 9

changes.mady.by.user Ondrej Špalek

Saved on

compared with

New Version Current

changes.mady.by.user Martin Trgiňa

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Removed translated content for 'zh'
Sv translation
languageen

/api/reports/views/:id/table/indicators/:iid/conditions

This method returns the conditional formatting of a selected table indicator.

Resource Information

Resource URL

https://service.belladati.com/api/reports/views/:id/table/indicators/:iid/conditions

HTTP Method

GET

Request Parameters

Parameters

Detail

Example

id

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

123
iidID of the indicator. This ID is part of the /api/views/:id/table/indicators response.AVn6TNRofe

Response Structure

Code Block
{ 
  "conditions" : [
	{
		 ...
	},
	{
		...
	}
  ]
 
}

JSON response contains array of conditions. Each contains multiple objects with following definition:

NameDescription
evaluationTypeType of conditional formatting (INDICATOR or FORMULA)
symbolSymbol of the conditional formatting (ARROW_UP, ARROW_DOWN, WARNING, etc. - see Types and enumerations)
compareValueCompare value
compareFormulaCompare formula (used when compareType=FORMULA_INDICATOR or evaluationType=FORMULA)
conditionUse conditions (EQ, BW, GTW, etc. - see Types and enumerations)
valueSecondary value, used for conditions BW, NOT_BW, GBY, LBY
compareTypeType of compare value (CONSTANT, PREV_VALUE, FORMULA_INDICATOR, INDICATOR)
colorColor of text
backgroundBackground color
indexOrder of the condition
descriptionDescription
cssClasscustom css class

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/indicators/AVn6TNRofe/conditions

The JSON format response:

Code Block
{
    "conditions": [
        {
            "evaluationType": "INDICATOR",
            "compareValue": 0,
            "condition": "GBY",
            "compareType": "CONSTANT",
            "color": "#1aff00",
            "background": "#e60e0e",
            "index": 0,
            "value": 2
        },
        {
            "evaluationType": "INDICATOR",
            "compareValue": 886076,
            "symbol": "ARROW_UP",
            "condition": "NOT_BW",
            "compareType": "CONSTANT",
            "color": "#17e6b5",
            "background": "#4f2bff",
            "index": 1,
            "value": 10000
        },
        {
            "evaluationType": "INDICATOR",
            "condition": "PGBY",
            "compareType": "PREV_VALUE",
            "color": "#547f4f",
            "index": 2,
            "description": "prev value",
            "value": 4
        },
        {
            "evaluationType": "INDICATOR",
            "condition": "GTE",
            "compareType": "FORMULA_INDICATOR",
            "compareFormula": "1000",
            "color": "#547f4f",
            "index": 3,
            "description": "ind formula"
        },
        {
            "evaluationType": "INDICATOR",
            "condition": "GTE",
            "compareType": "INDICATOR",
            "color": "#547f4f",
            "index": 4,
            "description": "indicator",
            "compareIndicator": "7as7FSMLAb"
        },
        {
            "evaluationType": "FORMULA",
            "condition": "GTE",
            "compareType": "CONSTANT",
            "compareFormula": "1000\t",
            "color": "#547f4f",
            "index": 5,
            "description": "formula"
        }
    ]
}

Next steps

List siblings

zh

（任意）次の構造でテーブルに適用されたフィルタ：

Sv translation
languageja
language

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

json

indicators/:iid/conditions

このメソッドは、選択された表インジケーターの条件付き書式を返します。この方法は、JSONフォーマットでテーブルを返却します。

リソース情報

リソースURL 

https://service.belladati.com/api/reports/views/:id/table/jsonindicators/:iid/conditions

HTTPメソッドHTTP方法

GET

リクエストパラメータ

リクエストパラメーター

パラメーター

詳細

例

id

テーブルのID。このIDは

表ID。このIDは、/api/reports/:id

responseの一部です。

 レスポンスの一部です。

123

filter

名
説明
drilldown

ドリルダウンが属性コードと次のような構造で定義されました

名
説明
opフィルタ操作タイプ - サポートされている値のリストをご参照してください。
value/values（任意）選択した「op」に依存します。フィルタの値または値を格納します。
 
iidインジケーターID。このIDは、/api/views/:id/table/indicators レスポンスの一部です。AVn6TNRofe

レスポンス構造

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"} } }
"conditions" : [
	{
		 ...
	},
	{
		...
	}
  ]
 
}

JSONレスポンスには、条件の配列が含まれています。それぞれに、次の定義を持つ複数のオブジェクトが含まれています:

名説明
evaluationType条件付き書式のタイプ (INDICATOR または FORMULA)
symbol条件付き書式の記号 (ARROW_UP, ARROW_DOWN, WARNING, etc. - Types and enumerations をご確認ください)
compareValue比較値
compareFormula比較式 (compareType=FORMULA_INDICATOR または evaluationType=FORMULA の場合に使用されます)
condition使用条件 (EQ, BW, GTW, etc. - Types and enumerations をご確認ください)
value

BW、NOT_BW、GBY、LBY条件に使用される2次値

compareType比較値のタイプ (CONSTANT, PREV_VALUE, FORMULA_INDICATOR, INDICATOR)
colorテキストの色
background背景色
index条件の順序
description説明
cssClassカスタムcssクラス

サンプルリクエスト/レスポンス

curl使用

レスポンスの構造

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

JSONレスポンスは、次の定義を持つ要素が含まれます。

名説明
rowsCountヘッダーとデータを含む総数行
nameテーブルビュー名
headerヘッダ要素を含む配列
bodyデータ要素を含む配列

サンプルリクエスト/レスポンス

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/jsonindicators/AVn6TNRofe/conditions
JSONフォーマットの応答

JSON形式のレスポンス:

Code Block
{
  
  "rowsCount" : 5, 
  "name" : "My Table Name", 
  "header" : [ 
    [ 
conditions": [
        {
            "evaluationType": "INDICATOR",
            "compareValue": 0,
            "condition": "GBY",
            { 
"compareType": "CONSTANT",
            "valuecolor" : "#1aff00",
   
         "typebackground" : "header" 
: "#e60e0e",
            "index": 0,
       } 
    ], "value": 2
    [    },
        {
 
           "valueevaluationType" : "INDICATOR",
            "compareValue": 886076,
            "typesymbol" : "header" 
ARROW_UP",
            } "condition": "NOT_BW",
    ]   
  ], 
  "bodycompareType" : ["CONSTANT",
 
    [ 
      { "color": "#17e6b5",
            "valuebackground" : "Value#4f2bff",
 
           "typeindex" :: 1,
            "headervalue": 10000
        },
        {
      {       "evaluationType": "INDICATOR",
            "stylecondition" : "PGBY" color:rgb(77, 77, 77) !important ; background-color:rgb(237, 237, 237); ", 
,
            "compareType": "PREV_VALUE",
            "color": "#547f4f",
            "index": 2,
            "description": "prev value" : "1,033,054,533,155" ,
            "value": 4
        },
        {
    ],         "evaluationType": "INDICATOR",
            "condition": "GTE",
    [ 
        "compareType": "FORMULA_INDICATOR",
            { "compareFormula": "1000",
            "valuecolor" : "Value Footnotes", 
#547f4f",
            "index": 3,
            "typedescription" : "headerind formula"
  
      },
  
      {
    
        "styleevaluationType" : " color:rgb(77, 77, 77) !important ; background-color:rgb(237, 237, 237); ", 
INDICATOR",
            "condition": "GTE",
            "valuecompareType" : "1INDICATOR",
  
      } 
    ], 
"color": "#547f4f",
     [ 
      { "index": 4,
            "valuedescription" : "Bindicator",
 
           "typecompareIndicator" : "header7as7FSMLAb"
 
       },
  
      {
 
           "styleevaluationType" : " color:rgb(77, 77, 77) !important ; background-color:rgb(237, 237, 237); ", 
FORMULA",
            "condition": "GTE",
            "compareType": "CONSTANT",
            "compareFormula": "1000\t",
            "value" : "5" 
color": "#547f4f",
            "index": 5,
          }   "description": "formula"
    ]
    }
    ]
}

Next steps

List siblings

Sv translation

Sv translation
languagecs

Sv translation
languagesk