UpdateProductSchema

概要

ユーザーが定義したスキーマを修正します。

リクエスト

API URL

URL: https://cw.apigw.ntruss.com/cw_fea/real/cw/api/schema
Method: PUT

リクエストヘッダ

共通設定に明示されたリクエストヘッダが必要です。

Content-Type: application/json
x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}

リクエストボディ

例

リクエスト例

PUT /cw_fea/real/cw/api/schema
Host: cw.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}

Payload:

{
  "prodName": "Custom/MyProduct",
  "cw_key":"xxxxxxxxxxxxxxxxxx",
  "fields": [
    {
      "dataType": "STRING",
      "name": "dimensionName",
      "dimension": true,
      "metric": false,
      "counter": false,
      "idDimension": true|false,
      "defaultMetric": false,
      "desc": "description"
    },
    {
      "dataType": "STRING|INTEGER|FLOAT|LONG",
      "name": "metricName",
      "dimension": false,
      "metric": true,
      "counter": false,
      "defaultMetric": true|false,
      "desc": "description",
      "aggregations": {
        "Min30": [
          "AVG",
          "SUM",
          "MIN",
          "MAX",
          "COUNT"
        ],
        "Hour2": [
          "AVG",
          "SUM",
          "MIN",
          "MAX",
          "COUNT"
        ],
        "Min2": [
          "AVG",
          "SUM",
          "MIN",
          "MAX",
          "COUNT"
        ],
        "Day1": [
          "AVG",
          "SUM",
          "MIN",
          "MAX",
          "COUNT"
        ],
        "Min5": [
          "AVG",
          "SUM",
          "MIN",
          "MAX",
          "COUNT"
        ],
        "Min1": [
          "AVG",
          "SUM",
          "MIN",
          "MAX",
          "COUNT"
        ]
      }
    }
  ]
}

**参照：**スキーマの登録とアップデートリクエストの違いは、既に登録されたスキーマのcw_keyが必要であり、スキーマをアップデートする際に指定された商品がまだない場合はエラーがレポートされます。

レスポンス例

エラーなしにアップデートが完了した場合、HTTP code 200と簡単なJSON形式のレスポンスがリターンされます。

{
    "msg": "ok"
}