url_renames Parameter

This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

Data Type: String

Used with the put manifest Method method to specify a list of files to be renamed. This parameter contains a list of key-and-value pairs in which the key for each pair is the site-relative URL of the old name and the value is the new file or folder name. The url_renames parameter is only valid when the options parameter is set to second pass.

The values to use with this parameter are passed to the client in the renamed urls section of the put manifest response code at the end of the first pass. The client must send that data back to the server in this parameter for the second pass.

Example

For example, assume that the server sends back to the client the following as part of the response code for the first pass.

<p>renamed urls=
<ul>
<li>Folder_1
<li>Folder_2
<li>Folder_3/File_1
<li>File_2
</ul>

The client then sends back to the server the following data in the url_renames parameter during the second pass.

method=put manifest:6.0.2.5523
&service_name=/
&options=second pass
&prefix=
&url_renames=[Folder_1;Folder_2;Folder_3/File_1;File_2]