アプリケーションプログラミングインターフェイスガイド> Webサービスオペレーション> オペレーションリファレンス> cancelArchive
 
cancelArchive
createExportArchiveまたはcreateImportArchiveで開始された進行中のアーカイブをキャンセルします。オペレーションが戻った後、アーカイブIDは無効になります。
アーカイブIDは単一のトランザクションでのみ有効であるため、このオペレーションは、createExportArchiveまたはcreateImportArchiveのいずれかを含む明示的なトランザクション内でのみ使用できます。 createExportArchiveまたはcreateImportArchiveが呼び出された後は、同じトランザクション内で実行され、アーカイブが閉じられていない限り、いつでも使用できます。
ロケーション
/services/webservices/system/admin/archive/operations/
リクエストエレメント
archiveId:最初のcreateExportArchiveまたはcreateImportArchiveによって提供されるアーカイブID。
リクエスト例
<archive:cancelArchive xmlns:archive="http://www.compositesw.com/services/system/admin/archive">
<archive:archiveId>archive_0037</archive:archiveId>
</archive:cancelArchive>
応答エレメント
status:
キャンセル済み:アーカイブが正常にキャンセルされた場合。
成功または失敗(必要に応じて):このオペレーションの前にアーカイブがすでに完了している場合。
archiveReport(オプション):ステータスがSUCCESSまたはFAILの場合、アーカイブ中に発生したエラーまたはその他のメッセージのリスト。それ以外の場合、このエレメントは存在しません。 archiveReportの各エントリエレメントの形式については、メッセージエレメントを参照してください。
エラー解析
NotFound:archiveIdは、cancelArchiveの実行時にまだ存在している必要があります。これは、アーカイブが以前にこのプロシージャを使用してキャンセルされた場合、getExportDataがデータの最後のチャンクを返した場合、performanceArchiveImportが以前にSUCCESSまたはFAILステータスを返した場合、またはこれが発生する可能性があります。オペレーションは別のトランザクションで呼び出されます。