コンテンツ属性情報取得処理
オペレーション名
コンテンツ属性情報取得
機能概要
入力データで指定したBoxのコンテンツIDからコンテンツ(ファイルまたはフォルダ)の属性情報を取得します。
本コンポーネントが使用するAPI仕様については、以下のBox APIリファレンスを参照してください。
-
https://ja.developer.box.com/reference/get-files-id/
-
https://ja.developer.box.com/reference/get-folders-id/
データモデル
本コンポーネントのデータモデルはXML型です。
プロパティ
変数の使用については、「変数」を参照してください。
基本設定
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
名前 |
必須 |
使用不可 |
スクリプトキャンバス上での名前を入力します。 |
|
|
入力データ |
必須 |
使用不可 |
スクリプトキャンバス上にあるコンポーネントを選択します。 |
|
必須設定
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
接続先 |
必須 |
使用不可 |
コネクションリソースを選択します。
|
|
> コメント
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
コメント |
省略可 |
使用不可 |
このコネクターの簡単な説明を記述することができます。 |
|
入力スキーマ
<?xml version="1.0" encoding="UTF-8" ?>
<requests>
<request login="" box_content_id="" box_content_type=""/>
:
</requests>
|
要素名 |
属性名 |
説明 |
必須/省略可 |
備考 |
|---|---|---|---|---|
|
requests |
|
|
|
|
|
request |
|
取得するコンテンツ情報の件数分だけ繰り返します。 |
|
|
|
login |
ユーザがログインに使用するメールアドレスを入力します |
必須 |
|
|
|
box_content_id |
属性情報を取得したいコンテンツのIDを入力します |
必須 |
コンテンツIDとはブラウザからBoxのコンテンツを開いた際のURL「https://*.app.box.com/file/<ID>」もしくは「https://*.app.box.com/folder/<ID>」の<ID>に該当します。 |
|
|
box_content_type |
属性情報を取得したいコンテンツ種別(ファイルまたはフォルダ)を入力します。
|
必須 |
|
出力スキーマ
<?xml version="1.0" encoding="UTF-8" ?>
<responses>
<response result="" status_code="" error_code="" message="" request_id="">
<request login="" box_content_id="" box_content_type=""/>
<content box_content_path="" content_created_at="" content_modified_at="" created_at="" modified_at="" name="" version_number="">
<shared_link access="" download_url="" is_password_enabled="" unshared_at="" url="">
<permissions can_download=""/>
</shared_link>
</content>
</response>
:
</responses>
|
要素名 |
属性名 |
説明 |
備考 |
|---|---|---|---|
|
responses |
|
|
|
|
response |
|
処理した入力の件数分だけ繰り返します。 |
|
|
result |
リクエスト実行結果が正常である場合は「succeeded」、入力が不正な場合は「skipped」、リクエスト実行結果がエラーである場合は「failed」を出力します。 |
|
|
|
status_code |
resultが「failed」の場合、BoxからのHTTPステータスコードを出力します。 |
|
|
|
error_code |
resultが「failed」の場合、エラー内容を特定するためのエラーコードを出力します。 |
|
|
|
message |
resultが「failed」もしくは「skipped」の場合、エラーメッセージを出力します。 |
|
|
|
request_id |
resultが「failed」の場合、Boxに対するリクエストを一意に識別するIDを出力します。 |
|
|
|
request |
|
処理した入力を表します。 |
|
|
login |
処理した入力のloginを出力します。 |
|
|
|
box_content_id |
処理した入力のbox_content_idを出力します。 |
|
|
|
box_content_type |
処理した入力のbox_content_typeを出力します。 |
|
|
|
content |
|
コンテンツの属性情報を表します。 |
|
|
box_content_path |
Boxのパスを出力します。 |
|
|
|
content_created_at |
コンテンツが最初に作成された日時を出力します。 |
|
|
|
content_modified_at |
コンテンツが最後に更新された日時を出力します。 |
|
|
|
created_at |
指定されたコンテンツがBox上で作成された日時を出力します。 |
|
|
|
modified_at |
指定されたコンテンツがBox上で最後に更新された日時を出力します。 |
|
|
|
name |
コンテンツの名前を出力します。 |
|
|
|
version_number |
ファイルのバージョン番号を出力します。 |
|
|
|
shared_link |
|
共有リンクを表します。 |
|
|
access |
共有リンクのアクセスレベルを出力します。
|
|
|
|
download_url |
Box上のファイルをダウンロードするためのURLを出力します。 |
|
|
|
is_password_enabled |
共有リンクでアクセスする際にパスワードが必要かどうかを出力します。
|
|
|
|
unshared_at |
共有リンクが共有解除される日時を出力します。 |
|
|
|
url |
共有リンクのURLを出力します。 |
|
|
|
permissions |
can_download |
共有リンクを通じてのダウンロードが許可されるかどうかを出力します。
|
|
大容量データ処理
大容量データ処理に対応していません。
トランザクション
トランザクションはサポートしていません。
PSPでの使用について
PSPでは使用できません。
使用できるコンポーネント変数
|
コンポーネント変数名 |
説明 |
備考 |
|---|---|---|
|
succeeded_count |
処理に成功した入力の件数が格納されます。 |
|
|
failed_count |
処理に失敗した入力の件数が格納されます。 |
|
|
skipped_count |
処理をスキップした入力の件数が格納されます。 |
|
|
message_category |
エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。 |
|
|
message_code |
エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。 |
|
|
message_level |
エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。 |
|
|
error_type |
エラー発生時、発生したエラーの種類が格納されます。 |
|
|
error_message |
エラー発生時、発生したエラーのメッセージが格納されます。 |
|
|
error_trace |
エラー発生時、発生したエラーのトレース情報が格納されます。 |
|
メッセージコード、例外メッセージ、制限事項
|
コネクター |
メッセージコード |
例外メッセージ |
制限事項 |
|---|---|---|---|
| Box コネクターのメッセージおよび制限事項 |
|
|
|
