UpdateProductSchema
    • PDF

    UpdateProductSchema

    • PDF

    記事の要約

    概要

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

    リクエスト

    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}
    

    リクエストボディ

    パラメータ名必須有無タイプ制約事項説明
    prodNameYString商品名
    cw_keyYString商品のcw_key
    fieldsYList<FieldDto>商品のスキーマ定義(field arrayで定義できます)

    リクエスト例

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

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.