結果の加工に使える値
アクションの実行結果は加工の加工に使える値は以下の通りです。
results(アクションの実行結果)
results
にはアクションの実行結果が格納されています。
例えば単一のユーザー情報を取得するアクションがあったとします。アクション実行成功時に、そのレスポンスの中に入っている id
を取得したい場合は、 results[0].success.id
と記述します。
ご覧の通り、この値は配列形式になっています。これは通常のMySQLやPostgreSQLなど、一部のデータソースの種類に紐づくアクションは実行結果が複数個になる可能性があるためです。
また、success
と記載されているとおり、実行成功時にのみ値が格納されます。実行失敗時には failure
に値(例:エラー文言)が格納されます。
basemachinaContext(ベースマキナのご利用状況・設定情報に関する値)
basemachinaContext
にはベースマキナのご利用状況・設定情報に関する値が格納されています。
プロパティ名 | 型 | 説明 | 例 |
---|---|---|---|
user | object | 現在のユーザーに関する情報を含むオブジェクト。id , email , name , groups , isTenantAdmin のプロパティを含みます。 | 詳細は後述します。 |
environment | object | 現在の環境に関する情報を含むオブジェクト。id , name のプロパティを含みます。 | { id: '1', name: 'Environment Name' } |
environmentVariables | object | キーが環境変数の名前、値が環境変数の値のオブジェクト。 | { USER_NAME: 'example-user', PROJECT: 'example-project' } |
groups | Array | 現在のプロジェクトに存在するグループに関する情報を含むオブジェクトの配列。各オブジェクトは id , name のプロパティを含みます。 | [{ id: '1', name: 'Group1' }, { id: '2', name: 'Group2' }] |
なお、user
プロパティのオブジェクトの各プロパティは以下の通りです。
プロパティ名 | 型 | 説明 | 例 |
---|---|---|---|
id | string | ユーザーのID | '1' |
email | string | ユーザーのメールアドレス | 'user@example.com' |
name | string | ユーザー名 | 'User Name' |
groups | Array | ユーザーが所属するグループに関する情報を含むオブジェクトの配列。 | [{ id: '1', name: 'Group1' }] |
isTenantAdmin | boolean | ユーザーが企業アカウント管理者であればtrue です。 | true |
experimental(試験的に導入されている値)
experimental
の値は、アクションの実行結果を加工するために有用な一方で、今後、破壊的変更がありえます。
具体的な内容は以下のとおりです。
args(アクション実行時に入力した引数の値)
args
にはアクション実行時に入力した引数の値が格納されています。アクション実行のフォームで入力した値が、そのまま args
に格納されます。