【公式】[Box]グループ更新

オペレーション名

グループ更新

機能概要

入力データで指定したBoxのグループを更新します。

= 備考 =

本コンポーネントが使用するAPI仕様については、以下のBox APIリファレンスを参照してください。

https://ja.developer.box.com/reference/put-groups-id/

データモデル

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

プロパティ

= 備考 =

変数の使用については、「変数」を参照してください。

基本設定

項目名	必須/省略可	変数の使用	説明	備考
名前	必須	使用不可	スクリプトキャンバス上での名前を入力します。
入力データ	必須	使用不可	スクリプトキャンバス上にあるコンポーネントを選択します。

必須設定

項目名	必須/省略可	変数の使用	説明	備考
接続先	必須	使用不可	コネクションリソースを選択します。 [追加] 新規にコネクションリソースを追加します。 [一覧の編集] > HULFT INTEGRATE > コネクションで、コネクションリソースの設定を編集することができます。

項目名

必須/省略可

変数の使用

説明

備考

接続先

必須

使用不可

コネクションリソースを選択します。

[追加]: 新規にコネクションリソースを追加します。
[一覧の編集]: > HULFT INTEGRATE > コネクションで、コネクションリソースの設定を編集することができます。

項目名	必須/省略可	変数の使用	説明	備考
コメント	省略可	使用不可	このコネクターの簡単な説明を記述することができます。

スキーマ

入力スキーマ

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>name</column>
    <column>new_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	グループの名前を入力します。	必須
	new_name	グループの新しい名前を入力します。	省略可	注意この名前は、Boxにおける会社内で一意である必要があります。
	provenance	外部連携元の名前を入力します。	省略可	注意値を設定した場合、Box管理者が管理コンソールからグループ名やメンバーを直接編集できなくなります。
	external_sync_identifier	外部連携元の識別子を入力します。	省略可
	description	グループの説明を入力します。	省略可
	invitability_level	このグループをコラボレーション先に設定できるユーザの種類を入力します。	省略可	「admins_only」「admins_and_members」「all_managed_users」のいずれかを入力してください。
	member_viewability_level	このグループのメンバーを表示できるユーザの種類を入力します。	省略可	「admins_only」「admins_and_members」「all_managed_users」のいずれかを入力してください。

出力スキーマ

<?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を出力します。

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」
error_message	エラー発生時、発生したエラーのメッセージが格納されます。	デフォルト値はnullです。
error_trace	エラー発生時、発生したエラーのトレース情報が格納されます。	デフォルト値はnullです。

メッセージコード、例外メッセージ、制限事項

コネクター	メッセージコード	例外メッセージ	制限事項
Box コネクターのメッセージおよび制限事項

グループ更新処理