コンテンツ一覧取得処理

オペレーション名

コンテンツ一覧取得

機能概要

入力データで指定したコンテンツ(ファイルまたはフォルダ)の一覧情報をBoxから取得します。

本コンポーネントが使用するAPI仕様については、以下のBox APIリファレンスを参照してください。

https://ja.developer.box.com/reference/get-folders-id-items/

データモデル

本コンポーネントのデータモデルはXML型です。

プロパティ

変数の使用については、「変数」を参照してください。

基本設定

項目名	必須/省略可	変数の使用	説明	備考
名前	必須	使用不可	スクリプトキャンバス上での名前を入力します。

必須設定

項目名	必須/省略可	変数の使用	説明	備考
接続先	必須	使用不可	グローバルリソースを選択します。グローバルリソースの設定方法については、「グローバルリソースのプロパティ」を参照してください。 [追加]: 新規にグローバルリソースを追加します。 [一覧の編集]: 「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
所有者	必須	使用可	フォルダ所有者のログインに使用するメールアドレスを入力します。
Boxコンテンツの指定方法	必須	使用不可	Boxコンテンツの指定方法を選択します。 [パス]:(デフォルト) Boxコンテンツをパスで指定します。 [ID]: BoxコンテンツをIDで指定します。
フォルダパス	必須	使用可	Boxのフォルダパスを入力します。	[Boxコンテンツの指定方法]が[パス]の場合のみ表示されます。パスの形式については、「制限事項」を参照してください。
フォルダID	必須	使用可	BoxのフォルダIDを入力します。	[Boxコンテンツの指定方法]が[ID]の場合のみ表示されます。
再帰的に取得する	省略可	使用不可	指定したフォルダについて、再帰的に一覧を取得するかどうかを選択します。 [チェックあり]: 指定したフォルダにフォルダが含まれる場合、そのフォルダ以下のコンテンツ情報も再帰的に取得します。 [チェックなし]:(デフォルト) 指定したフォルダ内のコンテンツ情報のみ取得します。

データ処理方式

項目名	必須/省略可	変数の使用	説明	備考
データ処理方式	必須	使用不可	データ処理方式を選択します。 [スクリプトの設定を使用する]:(デフォルト) スクリプトプロパティの大容量データ処理の設定をアダプタに使用します。 [大容量データ処理を行わない]: 大容量データ処理を行いません。 [大容量データ処理を行う]: 大容量データ処理を行います。

項目名	必須/省略可	変数の使用	説明	備考
コメント	省略可	使用不可	このアダプタの簡単な説明を記述することができます。説明を記述すると、仕様書に反映させることができます。

スキーマ

入力スキーマ

ありません。

出力スキーマ

<?xml version="1.0"?>
<contents>
  <content id="" type="" box_content_path="" name="" extension="" size="" created_at="" modified_at="" content_created_at="" content_modified_at="" created_by="" modified_by="" owned_by="">
    <description></description>
  </content>
    :
</contents>

要素名	属性名	説明	備考
contents	-
content	-	取得したコンテンツごとに出現します。	各属性の詳細については、Box APIリファレンスの以下のページを参照してください。 File(https://ja.developer.box.com/reference/resources/file/) Folder(https://ja.developer.box.com/reference/resources/folder/)
	id	IDを出力します。
	type	種別を出力します。「file」:ファイル「folder」:フォルダ
	box_content_path	Boxのパスを出力します。
	name	名前を出力します。
	extension	ファイルの拡張子を出力します。	値が存在しない場合は空文字を出力します。フォルダの場合は常に空文字を出力します。
	size	サイズを出力します。単位はバイトです。
	created_at	コンテンツがBoxに作成された日時を出力します。
	modified_at	コンテンツがBoxで最後に更新された日時を出力します。
	content_created_at	コンテンツが最初に作成された日時を出力します。
	content_modified_at	コンテンツが最後に更新された日時を出力します。
	created_by	コンテンツをBoxに作成したユーザがログインに使用するメールアドレスを出力します。
	modified_by	コンテンツをBoxで最後に更新したユーザがログインに使用するメールアドレスを出力します。
	owned_by	所有者がログインに使用するメールアドレスを出力します。
description	-	説明を出力します。	値が存在しない場合は空文字を出力します。

Mapperでのスキーマ読み込み

スキーマは自動で読み込まれます。

詳細については、「スキーマ編集」を参照してください。

大容量データ処理

大容量データ処理に対応しています。

トランザクション

トランザクションはサポートしていません。

PSPでの使用について

PSPでは使用できません。

使用できるコンポーネント変数

コンポーネント変数名	説明	備考
count	出力の件数が格納されます。	デフォルト値は0です。
file_count	出力内のファイルの件数が格納されます。	デフォルト値は0です。
folder_count	出力内のフォルダの件数が格納されます。	デフォルト値は0です。
message_category	エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。	デフォルト値はnullです。
message_code	エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。	デフォルト値はnullです。
message_level	エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。	デフォルト値はnullです。
error_type	エラー発生時、発生したエラーの種類が格納されます。	デフォルト値はnullです。エラーの種類は、以下のような形式となります。例:「java.io.FileNotFoundException」 DataSpider Cloudのバージョンにより、格納される内容が変わる可能性があります。
error_message	エラー発生時、発生したエラーのメッセージが格納されます。	デフォルト値はnullです。 DataSpider Cloudのバージョンにより、格納される内容が変わる可能性があります。
error_trace	エラー発生時、発生したエラーのトレース情報が格納されます。	デフォルト値はnullです。 DataSpider Cloudのバージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

仕様制限

出力の並び順は、Boxのパスの昇順となります。

主な例外

例外名	原因	対策
ResourceNotFoundException リソース定義が見つかりませんでした。名前:[]	[接続先]が指定されていません。	[接続先]を指定してください。
ResourceNotFoundException リソース定義が見つかりませんでした。名前:[<グローバルリソース名>]	[接続先]で選択されたリソース定義が見つかりません。	[接続先]で指定したグローバルリソースを確認してください。
InvalidPropertyConfigurationException 項目所有者にBoxに存在しない値が入力されました。	指定した[所有者]に該当するユーザが存在しません。	Boxに存在する[所有者]を指定してください。
InvalidPropertyConfigurationException 項目フォルダパスには有効なフォルダのパスを入力してください。	[フォルダパス]が有効ではありません。	以下のことを確認してください。 [フォルダパス]が存在するか [フォルダパス]で指定しているパスがフォルダであるか
InvalidPropertyConfigurationException 項目フォルダID には有効なフォルダのIDを入力してください。	[フォルダID]が有効ではありません。	以下のことを確認してください。 [フォルダID]が存在するか [フォルダID]で指定しているIDがフォルダであるか
BoxClientException	Boxからエラーが返されました。	メッセージの詳細については、Box開発者向けドキュメントポータル(https://ja.developer.box.com/)を参照してください。