cancelArchive
Cancel an in-progress archive that was started with
createExportArchive or
createImportArchive. After the operation returns, the archive ID is no longer valid.
The archive ID is only valid during a single transaction, so this operation can only be used within an explicit transaction that also contains either createExportArchive or createImportArchive. It can be used any time after createExportArchive or createImportArchive is called, as long as this is done within the same transaction and the archive has not been closed.
Location
/services/webservices/system/admin/archive/operations/
Request Elements
archiveId: The archive ID provided by the initial createExportArchive or createImportArchive.
Request Example
<archive:cancelArchive xmlns:archive="http://www.compositesw.com/services/system/admin/archive">
<archive:archiveId>archive_0037</archive:archiveId>
</archive:cancelArchive>
Response Elements
status:
• CANCELED: If the archive was successfully canceled.
• SUCCESS or FAIL (as appropriate): If the archive had already completed prior to this operation.
archiveReport (optional): If the status is SUCCESS or FAIL, lists of errors or other messages that occurred during the archive. Otherwise, this element does not exist. For the format of each entry element in archiveReport, see
Messages Element.
Faults
NotFound: The archiveId must still exist at the time of cancelArchive execution. This can occur if the archive was previously canceled using this procedure, if the getExportData returned the last chunk of data, if
performArchiveImport previously returned a SUCCESS or FAIL status, or if this operation is called on a different transaction.