アクション詳細

IDを指定してアクションの詳細を1件取得します。引数のJSON Schemaが含まれるため、実行前のリクエスト組み立てや、引数フォームの動的生成に利用できます。

エンドポイント

GET /projects/{project_id}/environments/{environment_id}/actions/{action_id}

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

パスパラメータ

名前	型	必須	説明
`project_id`	`string`	必須	対象プロジェクトのID
`environment_id`	`string`	必須	対象環境のID
`action_id`	`string`	必須	対象アクションの識別子

リクエスト例

curl https://platform.basemachina.com/public/v1/projects/csi2hcc0iaejrqgivkfg/environments/9m4e2mr0ui3e8a215n4g/actions/send_email \
  -H "Authorization: Bearer $BM_TOKEN"

レスポンス

ステータス200 OKで、アクションリソースが1件返ります。

{
  "id": "send_email",
  "name": "メール送信",
  "description": "ユーザーにメール本文を送信する",
  "input_schema": {
    "type": "object",
    "properties": {
      "user_id": {
        "type": "string",
        "description": "ユーザーID",
        "x-basemachina-input-type": "text"
      },
      "subject": {
        "type": "string",
        "maxLength": 200,
        "x-basemachina-input-type": "text"
      },
      "body": {
        "type": "string",
        "x-basemachina-input-type": "text",
        "x-basemachina-multiline": true
      }
    },
    "required": ["user_id", "subject", "body"],
    "additionalProperties": false
  }
}

フィールド

フィールド	型	説明
`id`	`string`	アクションの識別子。実行時のパスパラメーターに使用する
`name`	`string`	管理画面に表示されるアクション名
`description`	`string`	アクションの説明文
`input_schema`	`object`	引数のJSON Schema（2020-12 draft）。形式の詳細はアクション一覧

無効化されたアクションを指定すると404 not_foundが返ります。再度有効化されるまで公開APIからは参照できません。

エラー

ステータス	`code`	発生条件
`400`	`bad_request`	リクエストパラメーターが不正
`401`	`unauthorized`	`Authorization`ヘッダー欠落・トークン検証失敗
`404`	`not_found`	指定したIDのアクションが存在しない、または無効化されている
`500`	`internal_error`	gatewayまたは内部APIの障害

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

次のステップ

取得したinput_schemaに従って引数オブジェクトを組み立て、アクション実行を呼び出す

アクション一覧アクション実行