Method RenameRemoteFolderElement

RenameRemoteFolderElement(String, String, String)

Rename a remote folder element (remote folder or document). If an element with the same name already exists, a unique name is created.

Declaration

string RenameRemoteFolderElement(string connectionId, string remoteFolderElementPath, string newName)

Parameters

Type	Name	Description
System.String	connectionId	The connection id to identify your connection. See also ConnectionId
System.String	remoteFolderElementPath	Path to element which is renamed
System.String	newName	New global name of the folder element

Returns

Type	Description
System.String	The new name of the folder element.

Examples

POST http://YourServerName/InfoShare/Json/RemoteFolder/RenameRemoteFolderElement

Example for rename a remote folder element.

{
   "connectionId": "e3b3b164-9b0b-4d00-9981-83fe4835df1a",
   "remoteFolderElementPath": "1eb9edb4-2ce0-e911-a94a-00155d290a08\\db8835d5-30e0-e911-a94a-00155d290a08",
   "newName": "NewRemoteFolderName"
}

Response:

{
   "RenameRemoteFolderElementResult": "NewRemoteFolderName"
}

Exceptions

Type	Condition
ServiceException	The connection id {connectionId} isn't valid or has expired (10008)
ServiceException	Not allowed to rename top-level folders (10020)
ServiceException	Not allowed to change the name of the folder element (10021)
ServiceException	Root folder not found (10023)
ServiceException	Folder not found {folderPath} (10025)
ServiceException	No parent folder found {folderPath} (10075)
ServiceException	Verification code is needed: Verification code not yet verified (10152)