ページを選択

変数

データベースに存在する変数をアップロード、取得、更新、削除するには、次の API メソッドを使用します。

get_variables

要求された変数を取得します。

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

パラメーター

名前 タイプ 必須 説明
project_id integer true 変数を取得するプロジェクトの ID
リクエストの例
# Get the variables with an ID of 12
GET index.php?/api/v2/get_variables/12

レスポンスの内容

{
    "offset": 0,
    "limit": 250,
    "size": 2,
    "_links": {
        "next": null,
        "prev": null
    },
    "variables": [
        {
            "id": 611,
            "name": "d"
        },
        {
            "id": 612,
            "name": "e"
        }
    ]
}

レスポンス フィールド

名前 タイプ 説明
改ページに関するフィールド array 既存の一括 GET API エンドポイントと同じフィールド
variables array オブジェクトの配列。配列の各エントリには以下が含まれます。

    • id – データベース内の変数の ID
    • name – 変数の名前

レスポンス コード

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

add_variable

新しい変数を作成します。

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

パラメーター

名前 タイプ 必須 説明
project_id integer true 変数を追加するプロジェクトの ID

リクエストの例

# Post the variable with an ID of 12
POST index.php?/api/v2/add_variable/12

リクエスト ボディ

{
    "id": 613,
    "name": "f"
}

レスポンスの内容

{
    "id": 1675,
    "name": "f"
}

レスポンス フィールド

名前 タイプ 説明
id integer 新しく追加する変数の ID
name string 新しく追加する変数の名前

レスポンス コード

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

update_variable

既存の変数を更新します。

POST index.php?/api/v2/update_variable/{variable_id}

パラメーター

名前 タイプ 必須 説明
variable_id integer true 更新する変数の ID

リクエストの例

# Post the variable with an ID of 611
POST index.php?/api/v2/update_variable/611

リクエスト ボディ

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

レスポンスの内容

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

レスポンス フィールド

名前 タイプ 説明
id integer 更新する変数の ID
name string 更新する変数の名前

レスポンス コード

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

delete_variable

変数を削除すると、対応する値もデータセットから削除されます。

既存の変数を削除します。

POST index.php?/api/v2/delete_variable/{variable_id}

パラメーター

名前 タイプ 必須 説明
variable_id integer true 削除する変数の ID

レスポンス コード

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