createExportArchive
エクスポート用のアーカイブを作成して準備します。アーカイブはその設定によって定義されます。設定は、エクスポートされるものを正確に定義します。
この操作は、
beginTransaction と
closeTransaction の呼び出しの間で、その使用と他のアーカイブ操作の使用をラップする明示的なトランザクションコンテキスト内で呼び出す必要があります。エクスポート アーカイブは、このオペレーションを使用してサーバー上に作成されます。作成後、エクスポート アーカイブは
getArchiveContents、
getArchiveExportSettings、および
updateArchiveExportSettings を使用してさらに操作することができます。これら3つの操作の複数回呼び出しを任意の順序で行い、エクスポートされる内容を分析、再定義することができます。満足できる結果であれば、クライアントは次に
getArchiveExportData を 1 回または複数回呼び出します。
getArchiveExportDataが呼び出された後、updateArchiveExportSettingsを呼び出すことはできなくなります。
最後のエクスポートデータがgetArchiveExportDataによって返されるとき、または
cancelArchiveが呼び出されると、サーバーのアーカイブの概念は存在しなくなり、これらのオペレーションのいずれかがさらに呼び出されます。 archiveIdが無効であるため、NotFoundフォールトが発生します。
アーカイブには、resourcesエレメントにリストされているすべてのリソースが含まれています。各リソースにはオプションのincludeChildrenエレメントがあり、設定されていない場合はデフォルトでTRUEになります。ユーザーがREAD権限を持たない子リソースを含むリソースをエクスポートする場合、子リソースは省略されます。 （エクスポートはセキュリティ障害を生成せずに成功しますが、リソースはエクスポートされません。）このエレメントが設定されていない場合、リソースはエクスポートされません。 「all」サブエレメントを使用して、サーバー上のすべてのリソースを含めることができます。
アーカイブには、usersエレメントで識別されたすべてのドメイン、ユーザー、およびグループの定義が含まれています。このエレメントが設定されていない場合、ドメイン、ユーザー、またはグループはエクスポートされません。 「all」サブエレメントを使用して、サーバーによって定義されたすべてのドメイン、ユーザー、およびグループを含めることができます。アーカイブには、serverAttributesエレメントで識別されたすべてのサーバー属性が含まれています。このエレメントが設定されていない場合、サーバー属性はエクスポートされません。
「all」サブエレメントを使用して、すべてのサーバー属性をエクスポートできます。サーバー属性の定義については
getServerAttributeDefsを、サーバー属性値については
getServerAttributesを参照してください。
exportOptionsエレメントでは、いくつかの追加オプションを指定できます。オプションを指定すると、関連する情報がエクスポートされます。そうでなければそうではありません。デフォルトでは、これらのオプションはいずれもエクスポートされません。有効なオプションは次のとおりです。
•INCLUDE_CACHING：リソースのキャッシュ構成を含めます。
•INCLUDE_CUSTOM_JAVA_JARS：カスタムJavaJARをエクスポートに含めます。 （管理者のみ）
•INCLUDE_STATISTICS：テーブルの境界や列の境界など、オブジェクトについて既知のリソース統計を含めます。
•INCLUDE_DEPENDENCY：エクスポートすることを選択したリソースのすべての依存リソースを収集して含めます。
•INCLUDE_PHYSICAL_SOURCE_INFO：含まれている物理ソースの機密接続情報を含めます。 （所有者のみ）
•INCLUDE_REQUIRED_USERS：必要なユーザーに関する情報をエクスポートファイルに含めます。
•INCLUDE_SECURITY：リソース特権設定を含めます。 （所有者のみ）
呼び出し元がADMINONLYとマークされたオプションを要求し、管理者権限を持っていない場合、セキュリティ障害が生成されます。
呼び出し元がOWNERONLYとマークされたオプションを要求した場合、そのオプションは、呼び出し元が所有者であるリソースにのみ適用されます。呼び出し元が管理者権限を持っている場合、このオプションは所有権に関係なくすべてのリソースに適用されます。メッセージは生成されますが、エクスポート中に障害は発生しません。
importHintsエレメントには、後でこのエクスポートされたデータのインポートを実行するクライアントが使用できる情報が含まれています。これにより、インポート時にどのリソースとユーザーをリバウンドする必要があるか、およびどのリソース属性（データベース接続情報など）を再マップする必要があるかについての先入観が組み込まれたエクスポートアーカイブを作成できます。
ロケーション
/services/webservices/system/admin/archive/operations/
リクエストエレメント
settings：エクスポートする情報の量の説明。設定の構造は次のとおりです。
•name：エクスポートアーカイブの名前。
•description：アーカイブの詳細な説明。
•type:
— BACKUP：このアーカイブ内のすべての情報は、インポート時にサーバー情報に置き換わります。
— ROOT：アーカイブ内のリソースは、再インポート時に再配置できません。
— PACKAGE：アーカイブ内のリソースは、再インポート時に再配置できます。
•resources（オプション）：エクスポートするリソースのリスト。
— all（オプション）：設定されている場合、サーバー上のすべてのリソースがエクスポートされます。
— resource（0以上）：エクスポートする個々のリソースのパスとタイプのペアのリスト:
includeChildren（オプション）：TRUEまたは未設定の場合、このリソースのすべての子を再帰的にエクスポートに含めます。 FALSEの場合、子を含めないでください。
•users（オプション）：エクスポートするユーザーのリスト。
ユーザーエレメントを参照してください
•serverAttributes（オプション）：エクスポートするサーバー属性のリスト。
— all（オプション）：設定されている場合、すべてのサーバー属性がエクスポートされます。
— attributes（オプション）：エクスポートするサーバー属性の名前のスペース区切りのリスト。
•exportOptions（オプション）：スペースで区切られたアーカイブオプションのリスト。
•importHints（オプション）：インポート中に使用できるヒント。
— rebindResources：インポート時にリバウンドする必要があるリソースのリスト。
— rebindUsers：インポート時に他のユーザーにマップする必要があるユーザーのリスト。
— remapAttributes：インポート中にマップする必要があるリソース属性を一覧表示します。
•createInfo（オプション）：このエレメントの設定はすべて無視されます。
応答エレメント
archiveId：アーカイブID。これは、このアーカイブをオペレーションするために他のアーカイブオペレーションによって使用されます。
エラー解析
IllegalArgument：タイプが不正な場合。
IllegalArgument：リソースパスまたはタイプのいずれかが不正な形式である場合。
IllegalArgument：設定のいずれかが不正であるか、不正な値が含まれている場合。
IllegalArgument：サーバー属性のいずれかが不正な形式である場合。
IllegalArgument：エクスポートオプションのいずれかが不正な形式の場合。
IllegalArgument：インポートヒントのいずれかが不正な形式である場合。
IllegalState：このオペレーションは、明示的なトランザクションコンテキスト内でのみ呼び出すことができます。 beginTransactionとcloseTransactionを使用します。
NotAllowed：明示的に名前が付けられたリソースをエクスポートできない場合。 includeChildrenを使用して、エクスポートが許可されていない暗黙的に識別されたリソースを含めても、この障害は発生しません。
NotFound：リソースパスとタイプのいずれかの部分が存在しない場合。
NotFound：ドメイン、ユーザー、またはグループのいずれかが存在しない場合。
NotFound：サーバー属性のいずれかが存在しない場合。
NotFound：importHintsで指定されたリソースのいずれかがエクスポートアーカイブに含まれていない場合。
NotFound：importHintsで指定されたユーザーのいずれかが、エクスポートアーカイブのリソース、特権、またはユーザーデータのいずれにも含まれていない場合。
セキュリティ：呼び出し元が、明示的に識別されたリソースパス内のすべてのアイテムに対するREADアクセス権を持っていない場合。 includeChildrenを使用して、呼び出し元がREADをオンにしていない暗黙的にインクルードされたリソースへのパスは、この障害を生成しません。
セキュリティ：呼び出し元に管理者権限がなく、管理者専用のエクスポートオプションを使用しようとした場合。
セキュリティ：呼び出し元がOWNER ONLYエクスポートオプションを使用しようとした場合、管理者権限がなく、管理者のみのエクスポートオプションを使用しようとします。