- URL:https://<root>/system/directories/<directoryName>/edit(POST only)
- Required Capability:Default administrator role | Security and infrastructure privilege
- Version Introduced:10.2.1
Description
The edit operation changes the physical path and description properties of the directory. This is useful when changing the location of a directory from a local path to a network share. However, the API does not copy your content and data from the old path to the new path. This has to be done independently by the system administrator.
Note:
After editing a directory, the portal is automatically restarted. The restart takes a couple of minutes to complete; your portal is temporarily unavailable during this time.
Request parameters
| Parameter | Details |
|---|---|
| physicalPath | The new path for the directory. Example |
| description | The new description for the directory. Example |
| f | The response format. The default is html. Values: html | json | pjson |
Example usage
Request at 10.5
The following is a sample POST request demonstrating the edit operation starting at 10.5, formatted for readability:
POST /webadaptor/portaladmin/system/directories/testDirectory/edit HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
physicalPath={
"type": "fileStore",
"provider": "FileSystem",
"connectionString": "//server/share/content",
"isConnectionStringEncrypted": false
}&description=The content directory.&f=jsonRequest prior to 10.5
The following is a sample POST request demonstrating the edit operation prior to 10.5:
POST /webadaptor/portaladmin/system/directories/testDirectory/edit HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
physicalPath=\\server\share\content&description=A network share to hold portal content.JSON Response example
{
"status": "success",
"recheckAfterSeconds": 10
}