getArchiveImportReport
Get the current status of an in-progress import.
This operation can only be used with an import archive. It can be used any time after
createImportArchive is called, as long as it is within the same transaction and the archive has not been closed. Especially if
performArchiveImport was called without blocking, subsequent calls to
getArchiveImportReport can be made to determine whether the import has completed or not. It only gets the messages that is generated if import completed.
If an import status is CANCELED or FAIL, the import is in an inconsistent state. The bounding transaction should be rolled back before performing other operations.
Location
/services/webservices/system/admin/archive/operations/
Request Elements
archiveId: The ID of the archive.
isBlocking If TRUE, this call does not return until the import has completed. If FALSE, this call returns immediately. Only TRUE is supported.
Response Elements
status:
• CANCELED: The archive was canceled during this call.
• SUCCESS: The import has completed.
• INCOMPLETE: The import is still in progress.
• FAIL: The import failed during or prior to this call.
archiveReport (optional): List of messages generated since the previous call to performArchiveImport or getArchiveImportReport, if any. If no messages exist, this element is unset. See
Messages Element for message structure.
Faults
IllegalArgument: If the isBlocking element is malformed.
IllegalState: If this operation is called using an export archive ID.
NotFound: If archive for the archive ID does not exist.