updateArchiveImportSettings
Update 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 any time after
createImportArchive is called as long as it is within the same transaction and the archive has not been closed.
Not setting a particular optional element within the settings elements means that no aspect of that setting is applied during import. No checks are made to determine whether any specified resources exist or whether any mapping creates a cyclical relationship.
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 exported. 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 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 the caller requests an option marked ADMIN ONLY and does not have admin privileges, a Security fault is generated.
— If the caller requests an option marked OWNER ONLY, that option is applied only 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 Elements
archiveId: The ID of the archive.
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 path-type pairs indicating resources that should not be imported. By default this is unset.
• relocateResources (optional): A mapping of resources from their location in the archive to where they should be imported. By default this is unset. Each mapping is a path-type pair indicating the “from” location and a path-type pair indicating the “to” location.
• rebindResources (optional): A mapping of resources references within the archive to where they should refer to. By default this is unset. Each mapping is a path-type pair indicating the “from” resource binding and a path-type pair indicating the “to” resource binding.
• rebindUsers (optional): A mapping of users within the archive to whom they should be. By default this is unset. Each mapping is a domainName-userName pair indicating the from user binding and a domainName-userName pair indicating the to user binding.
• remapAttributes (optional): List of resource attribute settings that should be applied on import. By default this is unset.
• map (optional):
— resource: A path-type pair indicating a resource.
• importOptions (optional): A space-separated list of name elements (archive options) indicating what additional features should be imported. By default, the same options used for export are used for import.
Response Elements
N/A
Faults
IllegalArgument: If any of the resource paths or types are malformed.
IllegalArgument: If a supplied attribute is malformed.
IllegalArgument: If any of the import options are malformed.
IllegalState: If this operation is called using an export archive ID.
NotAllowed: If the archive type is BACKUP or ROOT and the relocateResources element is set.
NotAllowed: If the archive type is BACKUP and the excludeResources element is set.
NotAllowed: If the archive type is BACKUP and the rebindResources element is set.
NotAllowed: If the archive type is BACKUP and the rebindUsers element is set.
NotAllowed: If the archive type is BACKUP and the remapAttributes element is set.
NotFound: If archive for the archive ID does not exist.
NotFound: If an importOption is set for which the correspond exportOption was not set.
Security: If the caller attempts to set an ADMIN ONLY import option and the caller does not have admin privileges.