アクション一覧

指定した環境で利用できるアクションの一覧を取得します。レスポンスには各アクションの引数スキーマも含まれるため、このAPIだけでアクション実行に必要な情報をまとめて取得できます。

エンドポイント

GET /environments/{environment_id}/actions

認証・共通ヘッダー・エラー形式は公開APIとはを参照してください。

パスパラメータ

名前	型	必須	説明
`environment_id`	`string`	必須	対象環境のID（`env_`で始まるULID）。管理画面の環境設定で確認できる

クエリパラメータ

名前	型	必須	説明
`limit`	`integer`	任意	1ページあたりの取得件数。`1`〜`100`、デフォルト`20`
`cursor`	`string`	任意	前ページのレスポンスの`next_cursor`を不透明な値としてそのまま指定する（`^[A-Za-z0-9+/=_-]+$`）

リクエスト例

curl https://platform.basemachina.com/public/v1/environments/env_01H.../actions \
  -H "Authorization: Bearer $BM_TOKEN" \
  -H "Basemachina-Project: prj_01H..."

レスポンス

ステータス200 OKで、以下のenvelope形式が返ります。

{
  "data": [
    {
      "id": "send_email",
      "name": "メール送信",
      "description": "ユーザーにメール本文を送信する",
      "input_schema": {
        "type": "object",
        "properties": {
          "user_id": { "type": "string", "description": "ユーザーID" },
          "subject": { "type": "string" },
          "body": { "type": "string" }
        },
        "required": ["user_id", "subject", "body"],
        "additionalProperties": false
      }
    }
  ],
  "has_more": false
}

has_moreがtrueのときは、レスポンスにnext_cursorが含まれます。次ページの取得情報はレスポンスボディのみで提供され、Linkなどのヘッダーは付与されません。

envelopeのフィールド

フィールド	型	説明
`data`	`array`	アクションリソースの配列
`has_more`	`boolean`	次ページが存在するかどうか
`next_cursor`	`string`	次ページ取得用のカーソル。`has_more`が`true`の場合のみ含まれる

data[]の各フィールド

フィールド	型	説明
`id`	`string`	アクションのID。実行時のパスパラメータに使用する
`name`	`string`	管理画面に表示されるアクション名
`description`	`string`	アクションの説明文
`input_schema`	`object`	引数のJSON Schema（2020-12 draft）。後述の引数スキーマを参照

無効化されたアクションはdata[]に含まれません。

引数スキーマ（input_schema）

input_schemaはJSON Schema 2020-12形式で、ベースマキナ独自の入力タイプはx-basemachina-*拡張で表現されます。

ベースマキナの入力タイプ	JSON Schemaでの表現
テキスト	`{ "type": "string", "x-basemachina-input-type": "text" }`（`pattern`、`minLength`、`maxLength`、`enum`などの制約がつく場合あり）
数値	`{ "type": "number", "x-basemachina-input-type": "number" }`（`minimum`、`maximum`がつく場合あり）
真偽値	`{ "type": "boolean", "x-basemachina-input-type": "bool" }`
日時	`{ "type": "string", "format": "date-time", "x-basemachina-input-type": "date", "x-basemachina-date-granularity": "datetime" }`
SQL	`{ "type": "string", "x-basemachina-input-type": "sql", "x-basemachina-format": "sql" }`
ファイル	`{ "type": "string", "contentEncoding": "base64", "contentMediaType": "image/png", "x-basemachina-input-type": "file", "readOnly": true }`
JSON値（テキスト）	`{ "type": "string", "x-basemachina-input-type": "json_text" }`
JSON値（数値）	`{ "type": "number", "x-basemachina-input-type": "json_number" }`
JSON値（日時）	`{ "type": "string", "format": "date-time", "x-basemachina-input-type": "json_date", "x-basemachina-date-granularity": "datetime" }`
配列	`{ "type": "array", "x-basemachina-input-type": "array", "items": {} }`
タプル	`{ "type": "array", "x-basemachina-input-type": "tuple", "prefixItems": [...], "minItems": N, "maxItems": N }`

enum制約付きのテキスト入力では、表示用ラベルがx-basemachina-select-labelsに格納されます。

{
  "type": "string",
  "enum": ["admin", "member"],
  "x-basemachina-select-labels": { "admin": "管理者", "member": "一般" }
}

エラー

ステータス	`code`	発生条件
`401`	`unauthorized`	`Authorization`ヘッダー欠落・トークン検証失敗
`422`	`argument_invalid`	`limit`が範囲外、`cursor`の形式不正など、クエリパラメータの値が不正
`500`	`internal_error`	gatewayまたは内部APIの障害

エラーコードの詳細は公開APIとはを参照してください。

次のステップ

取得したidを使ってアクション詳細を取得する
input_schemaから引数を組み立ててアクション実行を呼び出す

公開APIとはアクション詳細