Versions Compared

Key

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

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

This method creates a conditional formatting for a selected table indicator.

Resource Information

Resource URL

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

HTTP Method

POST

Request Parameters

Parameters

Detail

Example

id

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

123

iid

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

Form contents to submit in following JSON format:

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
descriptionDescription
cssClass(optional) custom css style



Code Block
{
	"evaluationType": "INDICATOR",
	"value":5,
	"compareValue": 15,
	"symbol": "WARNING",
	"condition": "BW",
	"compareType": "CONSTANT",
	"color": "#15d000",
	"background": "#8bffc5"
}


Response Structure

JSON response contains one JSON object with the following element:

indexOrder of the condition

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\"" -d "data={\"evaluationType\": \"INDICATOR\",\"value\":5,\"compareValue\": 15,\"symbol\": \"WARNING\",\"condition\": \"BW\",\"compareType\": \"CONSTANT\",\"color\": \"#15d000\",\"background\": \"#8bffc5\"}" https://service.belladati.com/api/reports/views/5672-UXF46PMUR7/table/indicators/AVn6TNRofe/conditions/create

The JSON format response:

Code Block
{
    "index": 6
}

List siblings

Sv translation
languageja

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

json

indicators/:iid/conditions/create

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

リソース情報

リソースURL /json

リソースURL

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

HTTP方法

GET

リクエストパラメータ

リクエストパラメーター

テーブルのID。このIDは responseの一部です。

(任意)次の構造でテーブルに適用されたフィルタ:

パラメーター

詳細

id

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

 response.

123

filter

説明
drilldown

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

説明
opフィルタ操作タイプ - サポートされている値のリストをご参照してください。
value/values(任意)選択した「op」に依存します。フィルタの値または値を格納します。

 

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"}
  }
}

レスポンスの構造

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

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

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

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

iid

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

Form contents to submit in following JSON format:

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
descriptionDescription
cssClass(optional) custom css style



Code Block
{
	"evaluationType": "INDICATOR",
	"value":5,
	"compareValue": 15,
	"symbol": "WARNING",
	"condition": "BW",
	"compareType": "CONSTANT",
	"color": "#15d000",
	"background": "#8bffc5"
}


レスポンス構造

JSON response contains one JSON object with the following element:

indexOrder of the condition

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

curl使用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

JSONフォーマットの応答:

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
-d "data={\"evaluationType\": \"INDICATOR\",\"value\":5,\"compareValue\": 15,\"symbol\": \"WARNING\",\"condition\": \"BW\",\"compareType\": \"CONSTANT\",\"color\": \"#15d000\",\"background\": \"#8bffc5\"}" https://service.belladati.com/api/reports/views/5672-UXF46PMUR7/table/indicators/AVn6TNRofe/conditions/create

JSON形式のレスポンス:

Code Block
{
    "index": 6
}

List siblings

List siblings

Sv translation
languagezh

...