Application Programming Interface Guide > Web Services Operations > Operations Reference > createImportArchive
 
createImportArchive
Create and prepare an archive for import.
The data element contains the data aggregated from prior calls to getArchiveExportData. CreateImportArchive must be called within an explicit transaction context wrapping its usage and that of other archive operations between beginTransaction and closeTransaction calls.
This operation creates an import archive on the server. After it is created, the import archive can be further manipulated using getArchiveContents, getArchiveImportSettings, and updateArchiveImportSettings. Multiple calls to these four operations can be made in any order to analyze and redefine what portion of the data should be imported. When satisfied, the client then calls performArchiveImport.
If performArchiveImport was called without blocking, subsequent calls to getArchiveImportReport can be made to determine whether the import has completed or not. After performArchiveImport is called, updateArchiveImportSettings can no longer be called. When a call to performArchiveImport completes with a SUCCESS or FAIL status, or when cancelArchive is called, the server’s concept of the archive no longer exists, and further calls to any of these operations results in NotFound faults because the archiveId is invalid.
Location
/services/webservices/system/admin/archive/operations/
Request Elements
data: The archive data to import. This is the data that was created by a prior call to getArchiveExportData.
Response Elements
archiveId: The archive ID.
Faults
IllegalArgument: If any of the data is malformed.
NotSupported: If the version of the archive data is not supported.