OnSheetWorkbookList - OnSheetワークブックの一覧

OnSheetのワークブックの一覧を取得します。

OnSheetとの連携の概要や必要な設定については、OnSheetとの連携についてを参照してください。

■ストリーム情報

入力	フォーマット	すべて
	接続数	無制限
	説明	入力ストリームは使用せず、すべて無視します。
出力	フォーマット	Record
	説明	ワークブック情報のレコードです。 各フィールドの順序は固定です。 フィールド名 データ型 説明 id String ワークブックのID path String ワークブックのパス name String ワークブック名 currRevId Integer ワークブックの現在のリビジョン workspaceId Integer オーナーワークスペースのID workspace String オーナーワークスペースのパス organisationId Integer 法人ID organisation String 法人名 publicAccess String 一般のアクセス権 isTemplate Boolean ワークブックがテンプレートであるかどうか isDelete Boolean ワークブックが削除されているイかどうか timeZone String タイムゾーン note String ノート createUserId Integer 作成者のID createUser String 作成者のパス createTime DateTime 作成日時 lastModifiedUserId Integer 更新者のID lastModifiedUser String 更新者のパス lastModifiedTime DateTime 更新日時 accessToken String アクセストークン

■コンポーネントプロパティ

名前	プロパティ型	マッピング	説明
コネクション名	connection	-	OnSheetサーバーへの接続情報を定義した汎用コネクションを指定します。
ユーザーを指定する	boolean	入力＆出力	処理の実行に使用するユーザーをコネクションで定義されているユーザーを使用するか、 プロパティで指定するかを指定します。 はい [true] - プロパティでユーザー名とパスワードを指定します。 いいえ [false] - コネクションで定義されているユーザー名とパスワードを使用します。
ユーザー名	string	入力＆出力	ユーザーを指定するが「はい」の場合に処理に使用するユーザー名を指定します。
パスワード	password	入力＆出力	ユーザーを指定するが「はい」の場合に処理に使用するユーザーのパスワードを指定します。
ワークスペース	string	入力＆出力	一覧取得を行うワークスペースを指定します。 省略した場合はログインユーザーの個人ワークスペースが対象になります。
リスト範囲	choice	入力＆出力	一覧取得を行う範囲を指定します。 ワークスペースのみ [self] - 指定ワークスペースの所有するワークブックのみ 共有されたブックを含む [shared] - 共有されたワークブックを含める 削除されたブック [deleted] - 削除されたワークブック

■トランザクション処理

コミット	何もしません。
ロールバック	何もしません。

■エラー処理

タイプ	パラ メータ	エラー処理フロー へのストリーム	エラー コード	説明
汎用	なし	コンポーネントの入力ストリーム	なし	WebAPIの実行でエラーになった場合

■コネクション設定

OnSheetコンポーネントを使用するためにはあらかじめ汎用コネクションにOnSheetサーバー接続用の設定をしておく必要があります。コネクション設定では以下のパラメータを定義します。

パラメータ名	設定内容
url	OnSheetサーバーのWebAPIのURLを指定します。 URLは通常「http://<ホスト名>/api/v1/rpc」です。
appKey	OnSheetサーバーのアプリケーションキーを指定します。 アプリケーションキーの生成方法についてはOnSheetのWebAPIガイドを参照してください。
organisation	OnSheetサーバーにログインするユーザーの法人名を指定します。
user	OnSheetサーバーにログインするユーザー名を指定します。
password	OnSheetサーバーにログインするユーザーのパスワードを指定します。
useProxy	FSMCで設定したプロキシーサーバを使用する場合「true」を指定します。 プロキシサーバを使用しない場合は設定不要です。