Application Programming Interface Guide > Web Services Operations > Operations Reference > getArchiveImportSettings
 
getArchiveImportSettings
Get the import settings that are to be used for controlling the archive import.
This operation can only be used with an import archive. It can be used anytime after createImportArchive is called, as long as it is within the same transaction and the archive has not been closed.
A number of options can be specified in the importOptions element. If an option is specified, the associated information is exported; otherwise, it is not. By default, if the caller has admin privileges, the setting of the importOptions is that of the exportSettings. If the caller does not have admin privileges, the default is the same except that any items marked as ADMIN ONLY are not included.
The valid options are:
INCLUDE_CACHING: Include caching configurations for resources.
INCLUDE_CUSTOM_JAVA_JARS: Include custom Java JARs in the export. (ADMIN ONLY)
INCLUDE_STATISTICS: Include any resources statistics known about things including the table boundaries, and column boundaries.
INCLUDE_DEPENDENCY: Gather and include all dependent resources for the resources you choose to export.
INCLUDE_PHYSICAL_SOURCE_INFO: Include sensitive connection information for included physical sources. (OWNER ONLY)
INCLUDE_REQUIRED_USERS: Include the information about the required users in the export file.
INCLUDE_SECURITY: Include resource privilege settings. (OWNER ONLY)
If an option is marked OWNER ONLY, that option is only be applied to resources where the caller is the owner. If the caller has admin privileges, the option is applied to all resources regardless of ownership. If the option cannot be applied, messages are generated, but no fault occurs during import.
Location
/services/webservices/system/admin/archive/operations/
Request Element
archiveId: The ID of the archive.
Response Elements
settings: Description of how much of the archive to import and what modifications should be made during import. The settings have the following structure:
excludeResources (optional): List of resources that should not be imported. By default this is unset.
entry (optional): Paths and types for the entries.
relocateResources (optional): List of mappings (using path-type pairs) of resources from their location in the archive to where they should be imported. By default this is unset.
rebindResources (optional): List of mappings (using path-type pairs) of resources references within the archive to where they should refer to. By default this is unset.
rebindUsers (optional): List of mappings (using domainName-userName pairs) of users within the archive from who they are to who they should be. By default this is unset.
remapAttributes (optional): List of resource attribute settings that should be applied on import. By default this is unset. Each resource has a map element that contains a path-type pair designating a resource, and an attribute element. see Attributes Element.
importOptions (optional): Space-separated list of archive options (name elements) indicating what additional features should be imported. By default, the same options used for export are used for import.
Faults
IllegalState: If this operation is called using an export archive ID.
NotFound: If archive for the archive ID does not exist.