コラボレーション追加処理

オペレーション名

コラボレーション追加

機能概要

入力データで指定したコラボレーションをBoxに追加します。
本コンポーネントが使用するAPI仕様については、以下のBox APIリファレンスを参照してください。

データモデル

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

プロパティ

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

スキーマ

入力スキーマ

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>content_owner_login</column>
    <column>box_content_path</column>
    <column>role</column>
    <column>accessor_type</column>
    <column>accessor_login</column>
    <column>accessor_group</column>
    <column>can_view_path</column>
    <column>notify</column>
  </row>
  <row>
    :
  </row>
</table>
要素名 ラベル 説明 必須/省略可 備考
row
-
 追加するコラボレーションの件数分だけ繰り返します。    
column content_owner_login 所有者がログインに使用するメールアドレスを入力します。 必須  
box_content_path コラボレーション対象のパスを入力します。 必須
  • パスの形式については、「制限事項」を参照してください。
role アクセスレベルを入力します。 必須
  • 「editor」「viewer」「previewer」「uploader」「previewer uploader」「viewer uploader」「co-owner」のいずれかを入力してください。
  • コラボレーション対象がファイルの場合、「editor」または「viewer」のいずれかを入力できます。
accessor_type コラボレータのタイプを入力します。 必須
  • ユーザを入力する場合は「user」、グループを入力する場合は「group」を入力してください。
accessor_login コラボレータのメールアドレスを入力します。 必須
  • accessor_typeが「user」の場合に入力します。
accessor_group コラボレータのグループ名を入力します。 必須
  • accessor_typeが「group」の場合に入力します。
can_view_path コラボレータがコラボレーション対象の親フォルダの内容を見えるかどうかを入力します。 省略可
  • 省略した場合、「false」を設定します。
notify コラボレータのメールアドレス宛てに通知を送信するかどうかを入力します。 省略可
  • 省略した場合、「true」を設定します。

出力スキーマ

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>result</column>
    <column>content_owner_login</column>
    <column>box_content_path</column>
    <column>accessor_type</column>
    <column>accessor_login</column>
    <column>accessor_group</column>
    <column>status_code</column>
    <column>error_code</column>
    <column>message</column>
    <column>request_id</column>
  </row>
  <row>
    :
  </row>
</table>
要素名 ラベル 説明 備考
row
-
 処理に失敗した入力の件数分だけ繰り返します。  
column result バリデーションエラーによりリクエストが実行されなかった場合は「skipped」、リクエスト実行結果がエラーである場合は「failed」を出力します。  
content_owner_login 処理に失敗した入力のcontent_owner_loginを出力します。  
box_content_path 処理に失敗した入力のbox_content_pathを出力します。  
accessor_type 処理に失敗した入力のaccessor_typeを出力します。  
accessor_login 処理に失敗した入力のaccessor_loginを出力します。  
accessor_group 処理に失敗した入力のaccessor_groupを出力します。  
status_code resultが「failed」の場合、BoxからのHTTPステータスコードを出力します。  
error_code resultが「failed」の場合、エラー内容を特定するためのエラーコードを出力します。  
message エラーメッセージを出力します。  
request_id resultが「failed」の場合、Boxに対するリクエストを一意に識別するIDを出力します。  

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
リソース定義が見つかりませんでした。名前:[<グローバルリソース名>]		 [接続先]で選択されたリソース定義が見つかりません。 [接続先]で指定したグローバルリソースを確認してください。