getArchiveExportData
Export some or all of the archive data. This operation performs the actual export of the archive created using
createExportArchive. After this operation is called, updateExportSettings can no longer be called. If maxBytes is unset, this operation returns the entire archive in one call.
If the status is INCOMPLETE, additional calls to
getArchiveExportData must be made to get the remainder of the archive.
If the status is SUCCESS,
cancelArchive is invoked, or the bounding transaction is closed, the archive process is closed and the archive ID becomes invalid. It is generally recommended that you always use maxBytes, because the actual size of the export data cannot be determined ahead of time and it can be very large depending on what is being exported.
This operation can only be used with an export archive. It can be used anytime after createExportArchive is called, as long as it is within the same transaction and the archive has not been closed.
Location
/services/webservices/system/admin/archive/operations/
Request Elements
archiveId: The ID of the export archive.
maxBytes (optional): The maximum number of bytes to retrieve for the archive in this call. This must be a positive number.
Response Elements
status:
• CANCELED: If the archive was canceled during this call.
• SUCCESS: If the export has completed.
• INCOMPLETE: If there is more archive data to be retrieved.
archiveReport (optional): List of messages generated during this call, if any. If no messages exist, this element is unset. See
Messages Element.
data (optional): The archive data.
Faults
IllegalArgument: If maxBytes is not a positive number.
IllegalState: If this operation is called using an import archive ID.
NotFound: If archive for the archive ID does not exist.