トリガーとアクション

Index

1. トリガーとアクションの説明・使い方
2. Object定義

トリガーとアクションの説明・使い方

種別	トリガー名またはアクション名	説明
トリガー	When BOT execution is completed	BOT実行完了をトリガーとします。 BOTの出力値を取得し、以降のアクションで利用できます。
アクション	Execute BOT	クラウドBOT上のBOTをアクションとして実行する事ができます。 BOT実行時の入力値を指定できます。また、BOT完了時の出力値を以降のアクションで利用できます。
アクション	Upload file	ファイルデータをクラウドBOTへアップロードします。 File ref値が出力値として取得でき、その出力値はExcute BOTで使うことができます。
アクション	Download file	クラウドBOTからファイルデータをダウンロードします。 File ref値からファイルを取得することができます。

When BOT execution is completed (トリガー)

BOT実行完了をトリガーとします。
BOTの出力値を取得し、以降のアクションで利用できます。

「When BOT execution is completed」の設定値(Setup)

Language	BOT実行言語を選択します。
Contract	クラウドBOTの契約を選択します。クラウドBOTで外部連携が有効の契約を選択できます。
BOT	トリガーをかけるBOTを選択します。クラウドBOTで外部連携済みのBOTが選択できます。

「When BOT execution is completed」のInput Objectの定義はこちらをご覧ください。

「When BOT execution is completed」の実行結果(Output)

「When BOT execution is completed」の実行結果(Output)として、Bot Result Objectが出力されます。

詳細はBot Result Objectを参照してください。

Execute BOT(アクション)

クラウドBOT上のBOTをアクションとして実行する事ができます。
BOT実行時の入力値を指定できます。また、BOT完了時の出力値を以降のアクションで利用できます。

「Execute BOT」の設定値(Setup)

Language	BOT実行言語を選択します。
Contract	クラウドBOTの契約を選択します。クラウドBOTで外部連携が有効の契約を選択できます。
BOT	実行するBOTを選択します。クラウドBOTで外部連携済みのBOTが選択できます。
Async	[Yes]BOTを非同期で実行します。BOTの実行開始をもって即時レスポンスを返します。 [No]BOTを同期で実行します。BOT実行完了時にレスポンスを返します。 *BOTを非同期で実行、またはBOT実行開始から25秒を超える場合は、BOTが実行中であってもその時点でレスポンスを返します。statusは"2"(実行中)になります。また、Cast URLが発行されます。
BOT入力値	BOTの入力値を設定します。* 未設定の場合、BOTのデフォルト値で実行されます。 * "optional fields available"を押し、フィールドを指定することで任意の入力値を設定することができるようになります。

「Execute BOT」のInput Objectの定義はこちらをご覧ください。

BOT入力値の入力について

BOT入力値のデータタイプによって入力の仕方が変わります。クラウドBOTのデータビューア入力インターフェースと比較しています。

テキストタイプ

テキストタイプのデータは、単一の文字列を指定します。

複数テキストタイプ

複数テキストタイプのデータは、複数文字列(配列/Array)を指定します。

ファイルタイプ

ファイルタイプのデータは、File ref値(配列/Array)を指定します。

グループの場合

グループの行は配列(Array)で表します。

INPUT MODEを"Fixed list"にし、"Add item"を押すことでグループ行を増やすことができます。

追加した1行内の入力の仕方は、データタイプによって変わります。クラウドBOTのデータビューア入力インターフェースと比較しています。

テキストタイプ

テキストタイプのデータは、複数文字列(配列/Array)を指定します。

複数テキストタイプ

複数テキストタイプのデータは、複数文字列(配列/Array)を指定します。

ファイルタイプ

ファイルタイプのデータは、File ref値(配列/Array)を指定します。

「Execute BOT」の実行結果(Output)

「Execute BOT」の実行結果(Output)として、Bot Result Objectが出力されます。

詳細はBot Result Objectを参照してください。

Upload file(アクション)

ファイルデータをクラウドBOTへアップロードします。
File ref値が出力値として取得でき、その出力値はExcute BOTで使うことができます。

「Upload file」の設定値(Setup)

Language	BOT実行言語を選択します。
Contract	クラウドBOTの契約を選択します。クラウドBOTで外部連携が有効の契約を選択できます。
File contents	ファイル（バイナリデータ）を指定します。前にあるトリガーやアクションの出力値からFile contentsを関連付けます。
File name	ファイルの名前を指定します。前にあるトリガーやアクションの出力値からNameを関連付けます。

「Upload file」のInput Objectの定義はこちらをご覧ください。

「Upload file」の実行結果(Output)

「Upload file」の実行結果(Output)として、Upload Result Objectが出力されます。

詳細はUpload Result Objectを参照してください。

Download file(アクション)

クラウドBOTからファイルデータをダウンロードします。
File ref値からファイルを取得することができます。

「Download file」の設定値(Setup)

Language	BOT実行言語を選択します。
Contract	クラウドBOTの契約を選択します。クラウドBOTで外部連携が有効の契約を選択できます。
File ref	File ref値を指定します。

「Download file」のInput Objectの定義はこちらをご覧ください。

「Download file」の実行結果(Output)

「Download file」の実行結果(Output)として、Download Result Objectが出力されます。

詳細はDownload Result Objectを参照してください。

Object定義

Triggers Parameter Object

When BOT execution is completedの設定値を格納するObjectです。構造は以下の通りです。

キー名	型	値
Language	string	リクエスト言語（日本語:ja 英語:en）
Contract	string	APIの公開パス
BOT	string	BOT ID

Execute BOT Parameter Object

Execute BOTの設定値を格納するObjectです。構造は以下の通りです。

キー名	型	値
Language	string	リクエスト言語（日本語:ja 英語:en）
Contract	string	APIの公開パス
BOT	string	BOT ID
Async	boolean	同期モード（ture:同期 false:非同期）
{データ名}または{グループ名[データ名]}	stringまたはArray	BOT入力値

BOT入力値について

BOT入力値はデータタイプにより値が変わります。

データタイプ	型	値
テキストタイプ	string	文字列
複数テキストタイプ	Array	文字列の配列
ファイルタイプ	Array	ファイルのref値

グループの場合

データタイプ	型	値
テキストタイプ	Array	文字列の配列
複数テキストタイプ・ファイルタイプ	Array	Group Row Data Objectの配列(list)

Upload Parameter Object

Upload fileの設定値を格納するObjectです。構造は以下の通りです。

キー名	型	値
Language	string	リクエスト言語（日本語:ja 英語:en）
Contract	string	APIの公開パス
File contents	string	バイナリデータ
File name	string	ファイル名

Download Parameter Object

Download fileの設定値を格納するObjectです。構造は以下の通りです。

キー名	型	値
Language	string	リクエスト言語（日本語:ja 英語:en）
Contract	string	APIの公開パス
File ref	string	ファイルのref値

Bot Result Object(Output)

When BOT execution is completed、Execute BOTの実行結果(Output)を格納するObjectです。構造は以下の通りです。

キー名	型	値
Code	integer	レスポンスコード
Job ID	string	ジョブID
BOT ID	string	BOT ID
BOT name	string	BOT名
Status	integer	実行ステータス(0:正常終了 1:エラー 2:実行中)
Start time	string<date-time>	実行を開始した時間
Elapsed time	integer	実行に要した秒数
Cast URL *	string	BOT実行中の仮想ブラウザ画面を参照するURL
Message	string	メッセージ
Output	Object	Output Object

* Statusが2の場合、表示されます。

Upload Result Object(Output)

Upload fileの実行結果(Output)を格納するObjectです。構造は以下の通りです。

キー名	型	値
Code	integer	レスポンスコード
File ref	string	ファイルのref値

Download Result Object(Output)

Download fileの実行結果(Output)を格納するObjectです。構造は以下の通りです。

キー名	型	値
File contents	string	バイナリデータ
File size	number	ファイルサイズ(byte)
File name	string	ファイル名

Output Object(Output)

実行結果(Output)の出力値を格納するObjectです。データ、グループではそれぞれ値が異なります。構造は以下の通りです。

キー名	型	値
{データ名}または{グループ名}	データ名…stringまたはArray / グループ名…Object	データ名… 出力データ値 / グループ名…Group Object

出力データ値について

出力データ値はデータタイプにより値が変わります。

データタイプ	型	値
テキストタイプ	string	文字列
複数テキストタイプ	Array	文字列の配列
ファイルタイプ	Array(List)	File Objectの配列

File Object

ファイルを格納するObjectです。構造は以下の通りです。

キー名	型	値
File ref	string	ファイルのref値
Meta	Object	Meta Object

Meta Object

ファイルのメタデータを格納するObjectです。構造は以下の通りです。

キー名	型	値
File name	string	ファイル名
File size	number	ファイルサイズ(byte)
Timestamp	string	ファイルの作成日時（UNIXタイムスタンプ）

Group Object

グループを格納するObjectです。構造は以下の通りです。

キー名	型	値
{データ名}	Array / Array(List)	出力データ名の配列 / Group Row Data Objectの配列

Group Row Data Object

グループの行データを格納するObjectです。構造は以下の通りです。

キー名	型	値
Values	Array	入力データ値の配列 / 出力データ値の配列

＜　前のセクションへ（Workatoと連携するための事前準備）