グループ作成処理
オペレーション名
グループ作成
機能概要
入力データで指定したグループをBoxに作成します。
本コンポーネントが使用するAPI仕様については、以下のBox APIリファレンスを参照してください。
-
https://ja.developer.box.com/reference/post-groups/
データモデル
本コンポーネントのデータモデルはテーブルモデル型です。
プロパティ
変数の使用については、「変数」を参照してください。
基本設定
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
---|---|---|---|---|
名前 |
必須 |
使用不可 |
スクリプトキャンバス上での名前を入力します。 |
|
入力データ |
必須 |
使用不可 |
スクリプトキャンバス上にあるコンポーネントを選択します。 |
|
必須設定
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
---|---|---|---|---|
接続先 |
必須 |
使用不可 |
コネクションリソースを選択します。
|
|
コメント
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
---|---|---|---|---|
コメント |
省略可 |
使用不可 |
このコネクターの簡単な説明を記述することができます。 |
|
スキーマ
入力スキーマ
<?xml version="1.0" encoding="UTF-8" ?> <table> <row> <column>name</column> <column>provenance</column> <column>external_sync_identifier</column> <column>description</column> <column>invitability_level</column> <column>member_viewability_level</column> </row> <row> : </row> </table>
要素名 |
ラベル |
説明 |
必須/省略可 |
備考 |
---|---|---|---|---|
row |
|
作成するグループの件数分だけ繰り返します。 |
|
|
column |
name |
グループの名前を入力します。 |
必須 |
注意
この名前は、Boxにおける会社内で一意である必要があります。 |
provenance |
外部連携元の名前を入力します。 |
省略可 |
注意
値を設定した場合、Box管理者が管理コンソールからグループ名やメンバーを直接編集できなくなります。 |
|
external_sync_identifier |
外部連携元の識別子を入力します。 |
省略可 |
|
|
description |
グループの説明を入力します。 |
省略可 |
|
|
invitability_level |
このグループをコラボレーション先に設定できるユーザの種類を入力します。 |
省略可 |
|
|
member_viewability_level |
このグループのメンバーを表示できるユーザの種類を入力します。 |
省略可 |
|
出力スキーマ
<?xml version="1.0" encoding="UTF-8" ?> <table> <row> <column>result</column> <column>name</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」を出力します。 |
|
name |
処理に失敗した入力のnameを出力します。 |
|
|
status_code |
resultが「failed」の場合、BoxからのHTTPステータスコードを出力します。 |
|
|
error_code |
resultが「failed」の場合、エラー内容を特定するためのエラーコードを出力します。 |
|
|
message |
エラーメッセージを出力します。 |
|
|
request_id |
resultが「failed」の場合、Boxに対するリクエストを一意に識別するIDを出力します。 |
|
大容量データ処理
大容量データ処理に対応していません。
トランザクション
トランザクションはサポートしていません。
PSPでの使用について
PSPでは使用できません。
使用できるコンポーネント変数
コンポーネント変数名 |
説明 |
備考 |
---|---|---|
succeeded_count |
処理に成功した入力の件数が格納されます。 |
|
failed_count |
処理に失敗した入力の件数が格納されます。 |
|
skipped_count |
処理をスキップした入力の件数が格納されます。 |
|
message_category |
エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。 |
|
message_code |
エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。 |
|
message_level |
エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。 |
|
error_type |
エラー発生時、発生したエラーの種類が格納されます。 |
|
error_message |
エラー発生時、発生したエラーのメッセージが格納されます。 |
|
error_trace |
エラー発生時、発生したエラーのトレース情報が格納されます。 |
|
メッセージコード、例外メッセージ、制限事項
コネクター |
メッセージコード |
例外メッセージ |
制限事項 |
---|---|---|---|
Box コネクターのメッセージおよび制限事項 |