Share via

3.1.4.8.2.1 ImportWeb

Defines the input parameter of the ImportWeb operation.

 <s:element name="ImportWeb">
   <s:complexType>
     <s:sequence>
       <s:element minOccurs="1" maxOccurs="1" name="jobName" type="s:string" />
       <s:element minOccurs="1" maxOccurs="1" name="webUrl" type="s:string" />
       <s:element minOccurs="1" maxOccurs="1" name="dataFiles"
                  type="tns:ArrayOfString" />
       <s:element minOccurs="0" maxOccurs="1" name="logPath" type="s:string" />
       <s:element minOccurs="1" maxOccurs="1" name="includeUserSecurity"
                  type="s:boolean" />
       <s:element minOccurs="1" maxOccurs="1" name="overWrite" type="s:boolean" />
     </s:sequence>
   </s:complexType>
 </s:element>

jobName: Specifies the operation. It MUST NOT include any of the following characters:

  • Slash (/)

  • Double backslash (\\)

  • Colon (:)

  • Asterisk (*)

  • Question mark (?)

  • Double quotes (")

  • Angle brackets (< >)

  • Vertical bar (| )

  • Number sign (#)

  • \t

  • Curly braces ({ })

  • Percent sign (%)

webUrl: The URL of the resulting Web site. The caller MUST have site creation rights to perform this operation.

dataFiles: The URLs of the content migration package files on the server that the server imports to create the resulting Web site. The user MUST have read permission to all the specified content migration package files. This dataFiles element is an ArrayOfString as defined in section 2.2.4.2.

If the dataFiles array contains multiple content migration package files, the first content migration package file listed in the array MUST be the one that contains the list of all the content migration package files.

logPath:<15> The URL where the server places files describing the progress or status of the operation. The user MUST have write permission to this location. If this element is omitted, the server MUST NOT create any files describing the progress or status of the operation.

includeUserSecurity: Specifies whether or not to include access control list (ACL), security group, and membership group information in the resulting Web site. If true, the server MUST include ACL, security group, and membership group information from the content migration package files in the resulting Web site.

overWrite: Specifies whether or not to overwrite existing files at the location specified by logPath. The server MUST NOT overwrite existing files with new files if false is specified. If the server cannot create a new file because this parameter is set to false, it MUST return error code 11 as specified in section 3.1.4.8.2.2.