アクション
結果表示のカスタマイズ
結果の加工に使える値

結果の加工に使える値

アクションの実行結果は加工の加工に使える値は以下の通りです。

results(アクションの実行結果)

results にはアクションの実行結果が格納されています。

resultsの取得結果

例えば単一のユーザー情報を取得するアクションがあったとします。アクション実行成功時に、そのレスポンスの中に入っている id を取得したい場合は、 results[0].success.id と記述します。

resultsの使用例

ご覧の通り、この値は配列形式になっています。これは通常のMySQLやPostgreSQLなど、一部のデータソースの種類に紐づくアクションは実行結果が複数個になる可能性があるためです。

また、successと記載されているとおり、実行成功時にのみ値が格納されます。実行失敗時には failure に値(例:エラー文言)が格納されます。

basemachinaContext(ベースマキナのご利用状況・設定情報に関する値)

basemachinaContext にはベースマキナのご利用状況・設定情報に関する値が格納されています。

プロパティ名説明
userオブジェクト現在のユーザーに関する情報を含むオブジェクト。id, email, name, groups, isTenantAdmin のプロパティを含みます。詳細は後述します。
environmentオブジェクト現在の環境に関する情報を含むオブジェクト。id, name のプロパティを含みます。{ id: '1', name: 'Environment Name' }
environmentVariablesオブジェクトキーが環境変数の名前、値が環境変数の値のオブジェクト。{ USER_NAME: 'example-user', PROJECT: 'example-project' }
groupsオブジェクトの配列現在のプロジェクトに存在するグループに関する情報を含むオブジェクトの配列。各オブジェクトは id, name のプロパティを含みます。[{ id: '1', name: 'Group1' }, { id: '2', name: 'Group2' }]

なお、userプロパティのオブジェクトの各プロパティは以下の通りです。

プロパティ名説明
id文字列ユーザーのID'1'
email文字列ユーザーのメールアドレス'user@example.com'
name文字列ユーザー名'User Name'
groupsオブジェクトの配列ユーザーが所属するグループに関する情報を含むオブジェクトの配列。[{ id: '1', name: 'Group1' }]
isTenantAdmin真偽値ユーザーが企業アカウント管理者であればtrueです。true

experimental(試験的に導入されている値)

experimental にはアクションの実行結果を加工するために有用な一方で、今後破壊的変更が行なわれる可能性がある値が格納されています。

具体的な内容は以下のとおりです。

args(アクション実行時に入力した引数の値)

args にはアクション実行時に入力した引数の値が格納されています。アクション実行のフォームで入力した値が、そのまま args に格納されます。

argsの入力情報
argsの取得結果