ファイルリクエストコピー処理

オペレーション名

ファイルリクエストコピー

機能概要

入力データで指定したファイルリクエストをコピーし、Box上の別のフォルダに適用します。
本コンポーネントが使用するAPI仕様については、以下のBox APIリファレンスを参照してください。

データモデル

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

プロパティ

変数の使用については、「変数」を参照してください。
基本設定
項目名 必須/省略可 変数の使用 説明 備考
名前 必須 使用不可 スクリプトキャンバス上での名前を入力します。  
入力データ 必須 使用不可 スクリプトキャンバス上にあるコンポーネントを選択します。  
必須設定
項目名 必須/省略可 変数の使用 説明 備考
接続先 必須 使用不可 グローバルリソースを選択します。
グローバルリソースの設定方法については、「グローバルリソースのプロパティ」を参照してください。
  • [追加]:
    新規にグローバルリソースを追加します。
  • [一覧の編集]:
    「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
  
コメント
項目名 必須/省略可 変数の使用 説明 備考
コメント 省略可 使用不可 このアダプタの簡単な説明を記述することができます。
説明を記述すると、仕様書に反映させることができます。		  

スキーマ

入力スキーマ

<?xml version="1.0" encoding="UTF-8"?>
<requests>
  <request login="" file_request_id="" to_box_folder_path="" expires_at="" is_email_required="" is_description_required="" status="" title="" >
    <description></description>
  </request>
    :
</requests>
要素名 属性名 説明 必須/省略可 備考
requests
-
    
request
-
 コピーするファイルリクエストの件数分だけ繰り返します。    
login ユーザがログインに使用するメールアドレスを入力します。 必須  
file_request_id コピーするファイルリクエストを一意に表す識別子を入力します。 必須 ファイルリクエストのIDは、Boxのファイルリクエストの編集画面にアクセスし、URLから確認できます。
「https://*.box.com/filerequest/<ID>」の<ID>に該当します。
to_box_folder_path コピーするファイルリクエストを適用するフォルダのパスを入力します。 必須
  • パスの形式については、「制限事項」を参照してください。
expires_at ファイルリクエストが新しい送信を受け付けなくなる日時を入力します。 省略可
  • 省略した場合、コピー元の値が設定されます。
is_description_required ファイルリクエスト内の、ファイルの説明を必須項目とするかどうかを入力します。 省略可
  • 「true」または「false」のいずれかを入力してください。
  • 省略した場合、コピー元の値が設定されます。
is_email_required ファイルリクエスト内の、メールアドレスを必須項目とするかどうかを入力します。 省略可
  • 「true」または「false」のいずれかを入力してください。
  • 省略した場合、コピー元の値が設定されます。
status ファイルリクエストのステータスを入力します。
  • 「active」:ファイルリクエストでは新しい送信を受け付けます。
  • 「inactive」:ファイルリクエストでは新しい送信を受け付けなくなります。
 省略可
  • 省略した場合、コピー元の値が設定されます。
title ファイルリクエストのタイトルを入力します。 省略可
  • 省略した場合、コピー元の値が設定されます。
  • 半角スペースのみの文字列を入力した場合、省略とみなされます。
description
-
 ファイルリクエストの説明を入力します。 省略可
  • 省略した場合、コピー元の値が設定されます。
  • 半角スペースのみの文字列を入力した場合、省略とみなされます。

出力スキーマ

<?xml version="1.0" encoding="UTF-8"?>
<responses>
  <response result="" status_code="" error_code="" request_id="" message="">
    <request login="" file_request_id="" to_box_folder_path=""/>
    <file_request is_description_required="" is_email_required="" status="" title="" url="">
        <description></description>
    </file_request>
  </response>
    :
</responses>
要素名 属性名 説明 備考
responses
-
    
response
-
 処理した入力の件数分だけ繰り返します。
result リクエスト実行結果が正常である場合は「succeeded」、入力が不正な場合は「skipped」、リクエスト実行結果がエラーである場合は「failed」を出力します。
status_code resultが「failed」の場合、BoxからのHTTPステータスコードを出力します。
error_code resultが「failed」の場合、エラー内容を特定するためのエラーコードを出力します。  
message resultが「skipped」または「failed」の場合、エラーメッセージを出力します。
request_id resultが「failed」の場合、Boxに対するリクエストを一意に識別するIDを出力します。
request
-
 処理した入力を表します。
login 処理した入力のloginを出力します。  
file_request_id 処理した入力のfile_request_idを出力します。
to_box_folder_path 処理した入力のto_box_folder_pathを出力します。
file_request
-
 ファイルリクエストを表します。
  • resultが「succeeded」以外の場合はこの要素が紐づく要素と属性の値に空文字を出力します。
expires_at ファイルリクエストが新しい送信を受け付けなくなる日時を出力します。  
is_description_required ファイルリクエスト内の、ファイルの説明を必須項目とするかどうかを出力します。  
is_email_required ファイルリクエスト内の、メールアドレスを必須項目とするかどうかを出力します。  
status ファイルリクエストのステータスを出力します。
title ファイルリクエストのタイトルを出力します。  
url ファイルリクエストに対して生成されたURLを出力します。
  • urlのドメインは、グローバルリソースの[ファイルリクエストドメイン名]に入力したものになります。
description
-
 ファイルリクエストの説明を出力します。  

Mapperでのスキーマ読み込み

スキーマは自動で読み込まれます。
詳細については、「スキーマ編集」を参照してください。

大容量データ処理

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

トランザクション

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

PSPでの使用について

PSPでは使用できません。

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

コンポーネント変数名 説明 備考
succeeded_count 処理に成功した入力の件数が格納されます。
  • デフォルト値は0です。
failed_count 処理に失敗した入力の件数が格納されます。
  • デフォルト値は0です。
skipped_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のバージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

仕様制限

主な例外

例外名 原因 対策
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[]		 [接続先]が指定されていません。 [接続先]を指定してください。
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[<グローバルリソース名>]		 [接続先]で選択されたリソース定義が見つかりません。 [接続先]で指定したグローバルリソースを確認してください。
InvalidPropertyConfigurationException
ファイルリクエストドメイン名が指定されていません。		 グローバルリソースの[ファイルリクエストドメイン名]が指定されていません。 [ファイルリクエストドメイン名]を指定してください。
InvalidPropertyConfigurationException
ドメイン名の形式が不正です。ファイルリクエストドメイン名：[]		 グローバルリソースの[ファイルリクエストドメイン名]の形式が不正です。 [ファイルリクエストドメイン名]を正しい形式で指定してください。