XML登録
ユーザ情報、権限グループ情報、フォルダイベント情報、フォルダ情報(フォルダツリーの構成)をそれぞれXML形式の定義ファイルを使って一括登録します。
下位互換のために残されている非推奨のAPIです。
Ver.1.4.0以降では、CSVファイルをインポートするAPIを使用してください。
(1) 必要な権限
ImportXML APIを使用するには以下の権限が必要です。
-
システム管理の更新権限
管理対象種別による違いは以下のとおりです。
- システム全体
-
管理情報の一括登録が可能
- グループ単位
-
使用不可
(2) リクエストURL
http(s)://Domain:xxxx/コンテキスト名/ImportXML
(3) リクエストインタフェース
項目名 |
説明 |
文字 |
省略 |
省略値 |
||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
xml_type |
XML種別 インポートするXMLの種別を指定します。
|
半角 |
× |
|
||||||||
upload |
XMLファイル インポートするXMLファイルの実体を指定します。 |
混在 |
× |
|
-
各XMLファイルのサンプルは、提供媒体のTOOLフォルダ内のXMLフォルダに格納されています。
-
それぞれのXML種別に対してXMLファイルに記述する項目については、以下のAPIのリクエストインタフェース項目を参照してください。
権限グループ情報
「権限グループ情報設定」のRegisterAuthorization
ユーザ情報
「ユーザ情報設定」のRegisterUserInformation
フォルダ情報
「オブジェクト情報登録」のRegisterObject
「オブジェクト権限設定」のRegisterUserOnObject
フォルダイベント情報
「フォルダイベント情報設定」のRegisterFolderEvent
ImportXML APIは、HULFT-WebFileTransfer Ver.1.1.0以降で追加された項目には対応していません。
- xml_type(XML種別)が“0”(権限グループ情報)の場合
-
target_admin_type(管理対象種別)
group_id(管理対象グループ)
- xml_type(XML種別)が“1”(ユーザ情報)の場合
-
user_auth_flag(認証設定方法)
auth_available_flag(ID/パスワード認証方法)
ldap_auth_id(LDAP認証ID)
edit_user_mail_flag(ユーザ編集メール通知)
edit_user_mail_template_flag(ユーザ編集通知メールテンプレート)
edit_user_mail_subject(ユーザ編集通知メールタイトル)
edit_user_mail_message(ユーザ編集通知メール本文)
force_change_passwd_flag(パスワード変更の強制)
- xml_type(XML種別)が“2”(フォルダ情報)の場合
-
option1(オプション1)
option2(オプション2)
option3(オプション3)
(4) レスポンスインタフェース
項目名 |
説明 |
備考 |
---|---|---|
auth_id |
権限グループID 権限グループIDが単一または複数返却されます。 |
*1 |
*1 |
: |
XMLフォーマットで返されます。形式は以下のとおりです。 <auth_id>権限グループID</auth_id> |
項目名 |
説明 |
備考 |
||||
---|---|---|---|---|---|---|
info_user |
ユーザ情報 ユーザ情報が単一または複数返却されます。
|
*1 |
*1 |
: |
XMLフォーマットで返されます。形式は以下のとおりです。 <info_user> <group_id>グループID</group_id> <user_id>ユーザID</user_id> </info_user> |
項目名 |
説明 |
備考 |
||
---|---|---|---|---|
info_object |
オブジェクト情報 オブジェクト情報が単一または複数返却されます。
|
*1 |
*1 |
: |
XMLフォーマットで返されます。形式は以下のとおりです。 <info_object> <object_id>オブジェクトID</object_id> </info_object> |
項目名 |
説明 |
備考 |
||
---|---|---|---|---|
folder_event_id |
フォルダイベントID フォルダイベントIDが単一または複数返却されます。
|
*1 |
*1 |
: |
XMLフォーマットで返されます。形式はいかのとおりです。 <folder_event_id>フォルダイベントID</folder_event_id> |