ページを選択

データセット

データセットをアップロード、取得、更新、削除するには、次の API メソッドを使用します。

get_dataset

要求されたデータセット パラメーターを取得します。

GET index.php?/api/v2/get_dataset/{dataset_id}

パラメーター

名前 タイプ 必須 説明
dataset_id integer true 取得するデータセットの ID
リクエストの例
# Get the dataset with an ID of 183
GET index.php?/api/v2/get_dataset/183

レスポンスの内容

{
    "id": 183,
    "name": "Default",
    "variables": [
        {
            "id": 1171,
            "name": "age",
            "value": "41"
        },
        {
            "id": 1170,
            "name": "birth_year",
            "value": "1980"
        },
        {
            "id": 1172,
            "name": "browser",
            "value": "Chrome"
        },
        {
            "id": 1169,
            "name": "name",
            "value": "Jon"
        },
        {
            "id": 1669,
            "name": "New_variable",
            "value": "m"
        }
    ]
}

レスポンスには次のフィールドが含まれます。

名前 タイプ 説明
id integer データセットの一意の ID
name string 指定されたデータセットの名前
variables array オブジェクトの配列各オブジェクトには以下が含まれます。

    • id: 変数の ID
    • name: 変数の名前
    • value: 変数に対応するデータセットの値

レスポンス コード

ステータス コード 説明
200 成功
400
  • 無効な dataset_id
  • dataset_id がありません
401 認証エラー
403
  • 権限が不十分です (このプロジェクトにアクセスできません)。
  • Enterprise ライセンス/サブスクリプションではありません。

get_datasets

要求されたデータセットのリストを取得します。

GET index.php?/api/v2/get_datasets/{project_id}

パラメーター

名前 タイプ 必須 説明
project_id integer true データセットを取得するプロジェクトの ID
リクエストの例
# Get the dataset with an ID of 2
GET index.php?/api/v2/get_datasets/2

レスポンスの内容

{
    "offset": 0,
    "limit": 250,
    "size": 4,
    "_links": {
        "next": null,
        "prev": null
    },
    "datasets": [
        {
            "id": 183,
            "name": "Default",
            "variables": [
                {
                    "id": 1171,
                    "name": "age",
                    "value": "41"
                },
                {
                    "id": 1170,
                    "name": "birth_year",
                    "value": "1980"
                },
                {
                    "id": 1172,
                    "name": "browser",
                    "value": "Chrome"
                },
                {
                    "id": 1169,
                    "name": "name",
                    "value": "Jon"
                },
                {
                    "id": 1669,
                    "name": "New_variable",
                    "value": "m"
                }
            ]
        },
        {
            "id": 543,
            "name": "Dataset_name_3",
            "variables": [
                {
                    "id": 1171,
                    "name": "age",
                    "value": "38"
                },
                {
                    "id": 1170,
                    "name": "birth_year",
                    "value": "1983"
                },
                {
                    "id": 1172,
                    "name": "browser",
                    "value": "m,,"
                },
                {
                    "id": 1169,
                    "name": "name",
                    "value": "Ringo"
                },
                {
                    "id": 1669,
                    "name": "New_variable",
                    "value": "mnm"
                }
            ]
        },
        {
            "id": 544,
            "name": "New",
            "variables": [
                {
                    "id": 1171,
                    "name": "age",
                    "value": "value"
                },
                {
                    "id": 1170,
                    "name": "birth_year",
                    "value": "n"
                },
                {
                    "id": 1172,
                    "name": "browser",
                    "value": "m"
                },
                {
                    "id": 1169,
                    "name": "name",
                    "value": "m,"
                },
                {
                    "id": 1669,
                    "name": "New_variable",
                    "value": "nnn"
                }
            ]
        },
        {
            "id": 545,
            "name": "BOO",
            "variables": [
                {
                    "id": 1171,
                    "name": "age",
                    "value": "blue"
                },
                {
                    "id": 1170,
                    "name": "birth_year",
                    "value": "nnb"
                },
                {
                    "id": 1172,
                    "name": "browser",
                    "value": "fcg"
                },
                {
                    "id": 1169,
                    "name": "name",
                    "value": "n,"
                },
                {
                    "id": 1669,
                    "name": "New_variable",
                    "value": "nbnb"
                }
            ]
        }
    ]
}

レスポンスには次のフィールドが含まれます。

名前 タイプ 説明
改ページに関するフィールド array 既存の一括 GET API エンドポイントと同じフィールド
datasets array オブジェクトの配列。配列の各エントリは get_dataset と同じデータセットです

レスポンス コード

ステータス コード 説明
200 成功
400
  • 無効な project_id
  • project_id がありません
401 認証エラー
403
  • 権限が不十分です (このプロジェクトにアクセスできません)。
  • Enterprise ライセンス/サブスクリプションではありません。

add_dataset

新規データセットを作成します。

POST index.php?/api/v2/add_dataset/{project_id}

パラメーター

名前 タイプ 必須 説明
project_id integer true データセットを追加するプロジェクトの ID
リクエストの例
# Post the dataset with an ID of 12
POST index.php?/api/v2/add_dataset/12

リクエストボディ

{
    "id": 311,
    "name": "Def",
    "variables": []
}

レスポンスの内容

{
    "id": 648,
    "name": "Def",
    "variables": [
        {
            "id": 611,
            "name": "d",
            "value": ""
        },
        {
            "id": 612,
            "name": "e",
            "value": ""
        }
    ]
}
レスポンスには次のフィールドが含まれます。
名前 タイプ 説明
id integer データセットの一意の ID
name string 指定されたデータセットの名前
変数/値のペア array キー/値のペア。キーは変数名でなければなりません。値はデータセットに追加される値です。例：“browser”: “Chrome”

レスポンスコード

ステータス コード 説明
200 成功
400
  • 無効な project_id
  • project_id がありません
  • データセット名が無効です
  • データセット名はすでに現在のプロジェクトに存在します
  • 変数/値のペアに無効なデータが含まれています (変数名が存在しない、値が文字列としてサブミットされていない、値が長さの制限を超えているなど)
  • 許容されるデータセット数を超過しています
401 認証エラー
403
  • 権限が不十分です (このプロジェクトにアクセスできません)。
  • Enterprise ライセンス/サブスクリプションではありません。

update_dataset

既存のデータセットを更新します。

POST index.php?/api/v2/update_dataset/{dataset_id}

パラメーター

名前 タイプ 必須 説明
dataset_id integer true データセットを更新するプロジェクトの ID

リクエストの例

# Post the dataset with an ID of 2
POST index.php?/api/v2/update_dataset/2

リクエスト ボディ

更新データセットのリクエスト ボディは add_dataset のレスポンス フォーマットと同じです。

レスポンスの内容

成功した場合、このメソッドは add_dataset と同じレスポンス形式を使用して新しいデータセットを返します。

レスポンスには次のフィールドが含まれます。

名前 タイプ 説明
id integer データセットのデータベース ID
name string 指定されたデータセットの名前
変数/値のペア array キー/値のペア。キーは変数名でなければなりません。値はデータセットに追加される値です。例：“browser”: “Chrome”

レスポンス コード

ステータス コード 説明
200 成功
400
  • 無効な dataset_id
  • dataset_id がありません
  • データセット名が無効です
  • データセット名はすでに現在のプロジェクトに存在します
  • 変数/値のペアに無効なデータが含まれています (変数名が存在しない、値が文字列としてサブミットされていない、値が長さの制限を超えているなど)
  • 許容されるデータセット数を超過しています
401 認証エラー
403
  • 権限が不十分です (プロジェクトにアクセスできません)
  • 権限が不十分です (プロジェクトのテスト データに対する追加/編集権限がありません)
  • Enterprise ライセンス/サブスクリプションではありません。

delete_dataset

データセットを削除すると、データセットの値も削除されます。

既存のデータセットを削除します。

POST index.php?/api/v2/delete_dataset/{dataset_id}

パラメーター

名前 タイプ 必須 説明
dataset_id integer true 削除するデータセットの ID

レスポンス コード

ステータス コード 説明
200 成功
400
  • 無効な dataset_id
  • dataset_id がありません
  • dataset_id がデフォルトのデータ セットです
401 認証エラー
403
  • 権限が不十分です (プロジェクトにアクセスできません)
  • 権限が不十分です (プロジェクトのテスト データに対する追加/編集権限がありません)
  • Enterprise ライセンス/サブスクリプションではありません。