Skip to main content

テーブルデータ変更のチュートリアル

前提条件

  1. コンポーザーでテーブルが作成されている。テーブルの作成の詳細は、コンポーザーモジュールを参照してください。

  2. ???の説明どおり、Varicent APIキーが取得されている。

概要

このチュートリアルでは、次のREST API呼び出しを使用して、変更するデータを含むテーブルの名前と入力フォームのIDを取得します。

テーブル名を取得

この呼び出しは、変更するデータを含むテーブルの名前を取得します。

入力フォームIDを取得

この呼び出しは、テーブル名を取得呼び出しによって取得されたテーブル名を使用して、変更するデータを含む入力フォームのIDを取得します。

その後、次のREST API呼び出しを使用してデータを変更します。

テーブルデータを追加

この呼び出しは、テーブルにデータの行を追加します。

テーブルデータを更新

この呼び出しは、テーブルのデータの行を変更します。

テーブルデータを削除

この呼び出しは、テーブルの指定されたデータ行を削除します。

データの行をテーブルに追加

Varicent Incentivesでは、REST APIを使用して、データの行をテーブルに追加できます。

テーブルの正確な名前がわからない場合は、テーブル名を取得呼び出しを使用します。

テーブルに複数の入力フォームがある場合は、入力フォームを取得呼び出しを使用して入力フォームIDを検索します。テーブルに追加の入力フォームが含まれていない場合、入力フォームIDはゼロ（0）です。

  • 次のリクエストを行います。

    POST /api/v1/customtables/{tablename}/inputforms/{inputformID}/data

    追加するデータがリクエストボディに含まれている場合：

    注記

    リクエストボディはJSON形式である必要があります。

    {
"rows":[["<column1data>","<column2data>"]],
"inputFormId":<inputformid>,
"effectiveDate":<effectivedate>
}

    テーブルが有効な日付でない場合、effectiveDateはnullです。

    例：

    curl -X POST -H "Authorization: Bearer API_KEY" 
-H "Model: YOUR_CLIENT_MODEL” 
-H "Content-Type: application/json" 
https://YOUR_ICM10_API_SERVER_ADDRESS/api/v1/customtables/Demo/inputforms/0/data

    リクエストボディ：

    {
"rows":[["AE001","Dan Huddle"]],
"inputFormId":0,
"effectiveDate":null
}

[en] Adding multiple rows of data to a table

[en] If you want to add multiple rows of data to a table, use the following REST API instead, with the data you want contained in the request body:

[en] POST /api/v1/customtables/{tablename}/inputforms/{inputformID}/data/rows

{
"rows":[
    ["<row1column1data>","<row1column2data>"]
    ["<row2column1data>","<row2column2data>"]
],
"inputFormId":<inputformid>,
"effectiveDate":<effectivedate>
}

[en] For example:

curl -X POST -H "Authorization: Bearer API_KEY" 
-H "Model: YOUR_CLIENT_MODEL” 
-H "Content-Type: application/json" 
https://YOUR_ICM10_API_SERVER_ADDRESS/api/v1/customtables/Demo/inputforms/0/data/rows

[en] Request body:

{
"rows":[
    ["AE001","Dan Huddle"]
    ["AE002", "Anita Harper"]
],
"inputFormId":0,
"effectiveDate":null
}

注意

[en] We don't recommend using API calls to import data in bulk. Best practice is to use the data import tools available in the Data module of IncentivesIncentives.

テーブルのデータ行の更新

Varicent Incentivesでは、REST APIを使用して、テーブルのデータ行を変更できます。

テーブルの正確な名前がわからない場合は、テーブル名を取得呼び出しを使用します。

テーブルに複数の入力フォームがある場合は、入力フォームを取得呼び出しを使用して入力フォームIDを検索します。テーブルに追加の入力フォームが含まれていない場合、入力フォームIDはゼロ（0）です。

  • 次のリクエストを行います。

    PATCH /api/v1/customtables/{tablename}/inputforms/{inputformID}/data

    古いデータと、追加する新しいデータをリクエストボディに含めます。

    注記

    リクエストボディはJSON形式である必要があります。

    {
"oldRows":[["<oldColumn1Data>"","<oldColumn2Data>"]],
"rows":[["<newColumn1Data>","<newColumn2Data>"]],
"inputFormId":<inputFormID>,
"effectiveDate":<effectiveDate>,
"overwrite":[null]
}

    テーブルが有効な日付でない場合、effectiveDateはnullです。

    例：

    curl -X PATCH -H "Authorization: Bearer API_KEY" 
-H "Model: YOUR_CLIENT_MODEL” 
-H "Content-Type: application/json" 
https://YOUR_ICM10_API_SERVER_ADDRESS/api/v1/customtables/Demo/inputforms/0/data

    リクエストボディ：

    {
"oldRows":[["AE001","Dan Huddle"]],
"rows":[["AE001","Daniel Huddle"]],
"inputFormId":0,
"effectiveDate":null,
"overwrite":[null]
}

テーブルからのデータ行の削除

Varicent Incentivesでは、REST APIを使用して、テーブルの特定のデータ行を削除できます。

テーブルの正確な名前がわからない場合は、テーブル名を取得呼び出しを使用します。

テーブルに複数の入力フォームがある場合は、入力フォームを取得呼び出しを使用して入力フォームIDを検索します。テーブルに追加の入力フォームが含まれていない場合、入力フォームIDはゼロ（0）です。

  • 次のリクエストを行います。

    DELETE /api/v1/customtables/{tablename}/inputforms/{inputformID}/data

    削除するデータがリクエストボディに含まれている場合：

    注記

    リクエストボディはJSON形式である必要があります。

    {
"rows":[["<column1data>","<column2data>"]],
"inputFormId":<inputformid>,
"effectiveDate":<effectivedate>
}

    例：

    curl -X DELETE -H "Authorization: Bearer API_KEY" 
-H "Model: YOUR_CLIENT_MODEL” 
-H "Content-Type: application/json" 
https://YOUR_ICM10_API_SERVER_ADDRESS/api/v1/customtables/Demo/inputforms/0/data

    リクエストボディ：

    {
"rows":[["AE001","Dan Huddle"]],
"inputFormId":0,
"effectiveDate":null
}