getArchiveExportData
アーカイブデータの一部またはすべてをエクスポートします。このオペレーションは、
createExportArchiveを使用して作成されたアーカイブの実際のエクスポートを実行します。このオペレーションが呼び出されると、updateExportSettingsを呼び出すことができなくなります。 maxBytesが設定されていない場合、このオペレーションは1回の呼び出しでアーカイブ全体を返します。
ステータスがINCOMPLETEの場合、アーカイブの残りを取得するには、
getArchiveExportDataを追加で呼び出す必要があります。
ステータスがSUCCESSの場合、
cancelArchiveが呼び出されるか、バウンディングトランザクションが閉じられると、アーカイブプロセスが閉じられ、アーカイブIDが無効になります。エクスポートデータの実際のサイズを事前に決定することはできず、エクスポートされるものによっては非常に大きくなる可能性があるため、通常は常にmaxBytesを使用することをお勧めします。
このオペレーションは、エクスポートアーカイブでのみ使用できます。同じトランザクション内にあり、アーカイブが閉じられていない限り、createExportArchiveが呼び出された後はいつでも使用できます。
ロケーション
/services/webservices/system/admin/archive/operations/
リクエストエレメント
archiveId:エクスポートアーカイブのID。
maxBytes(オプション):この呼び出しでアーカイブ用に取得する最大バイト数。これは正の数でなければなりません。
応答エレメント
status:
•CANCELED:この通話中にアーカイブがキャンセルされた場合。
•SUCCESS:エクスポートが完了した場合。
•INCOMPLETE:取得するアーカイブデータがさらにある場合。
archiveReport(オプション):この呼び出し中に生成されたメッセージのリスト(存在する場合)。メッセージが存在しない場合、このエレメントは設定されていません。
メッセージエレメントを参照してください。
data(オプション):アーカイブデータ。
エラー解析
IllegalArgument:maxBytesが正の数でない場合。
IllegalState:このオペレーションがインポートアーカイブIDを使用して呼び出された場合。
NotFound:アーカイブIDのアーカイブが存在しない場合。