共有リンク削除処理
オペレーション名
共有リンク削除
機能概要
入力データで指定したBoxのコンテンツ(ファイルまたはフォルダ)から共有リンクを削除します。
本コンポーネントが使用するAPI仕様については、以下のBox APIリファレンスを参照してください。
-
https://ja.developer.box.com/reference/put-files-id--remove-shared-link/
-
https://ja.developer.box.com/reference/put-folders-id--remove-shared-link/
データモデル
本コンポーネントのデータモデルはXML型です。
プロパティ
変数の使用については、「変数」を参照してください。
基本設定
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
名前 |
必須 |
使用不可 |
スクリプトキャンバス上での名前を入力します。 |
|
|
入力データ |
必須 |
使用不可 |
スクリプトキャンバス上にあるコンポーネントを選択します。 |
|
必須設定
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
接続先 |
必須 |
使用不可 |
コネクションリソースを選択します。
|
|
> 詳細設定
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
ユーザ情報の取得方法 |
必須 |
使用不可 |
入力スキーマloginで指定されたユーザの情報を取得する方法を指定します。
|
Box上の管理対象ユーザが多い場合、[一括]を選択すると、ユーザ情報の取得に時間がかかり、処理時間が長くなります。 その場合、入力データに指定するユーザ数が少なければ、[ユーザごと]を選択することで処理時間を短縮できます。 |
|
Boxコンテンツの指定方法 |
必須 |
使用不可 |
Boxコンテンツの指定方法を選択します。
|
|
コメント
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
コメント |
省略可 |
使用不可 |
このコネクターの簡単な説明を記述することができます。 |
|
入力スキーマ
[Boxコンテンツの指定方法]の設定により、属性数および属性名が異なります。
<?xml version="1.0" encoding="UTF-8" ?>
<requests>
<request login="" box_content_path="" box_content_id="" box_content_type=""/>
:
</requests>
|
要素名 |
属性名 |
説明 |
必須/省略可 |
備考 |
|---|---|---|---|---|
|
requests |
|
削除するコンテンツの件数分だけ繰り返します。 |
|
|
|
request |
login |
ユーザがログインに使用するメールアドレスを入力します。 |
必須 |
|
|
box_content_path |
削除対象のコンテンツのパスを入力します。 |
必須 |
注意
|
|
|
box_content_id |
削除対象のコンテンツのIDを入力します。 |
必須 |
注意
|
|
|
box_content_type |
削除対象のコンテンツの種別(ファイルまたはフォルダ)を入力します。
|
必須 |
注意
|
出力スキーマ
[Boxコンテンツの指定方法]の設定により、属性数および属性名が異なります。
<?xml version="1.0" encoding="UTF-8" ??>
<responses?>
<response result="" status_code="" error_code="" message="" request_id="" /?>
<request login="" box_content_path="" box_content_id="" box_content_type=""/?>
</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を出力します。 |
|
|
|
box_content_path |
処理した入力のbox_content_pathを出力します。 |
注意
|
|
|
box_content_id |
処理した入力のbox_content_idを出力します。 |
注意
|
|
|
box_content_type |
処理した入力のbox_content_typeを出力します。 |
注意
|
大容量データ処理
大容量データ処理に対応していません。
トランザクション
トランザクションはサポートしていません。
PSPでの使用について
PSPでは使用できません。
使用できるコンポーネント変数
|
コンポーネント変数名 |
説明 |
備考 |
|---|---|---|
|
succeeded_count |
処理に成功した入力の件数が格納されます。 |
|
|
failed_count |
処理に失敗した入力の件数が格納されます。 |
|
|
skipped_count |
処理をスキップした入力の件数が格納されます。 |
|
|
message_category |
エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。 |
|
|
message_code |
エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。 |
|
|
message_level |
エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。 |
|
|
error_type |
エラー発生時、発生したエラーの種類が格納されます。 |
|
|
error_message |
エラー発生時、発生したエラーのメッセージが格納されます。 |
|
|
error_trace |
エラー発生時、発生したエラーのトレース情報が格納されます。 |
|
メッセージコード、例外メッセージ、制限事項
|
コネクター |
メッセージコード |
例外メッセージ |
制限事項 |
|---|---|---|---|
| Box コネクターのメッセージおよび制限事項 |
|
|
|
