- URL:
- https://<root>/system/directories/<directoryName>/edit
- Methods:
POST- Required Capability:
- Access allowed with the "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.
Request parameters
| Parameter | Details |
|---|---|
| The new path for the directory. Example |
| The new description for the directory. Example |
| The response format. The default is Values: |
Example usage
The following is a sample POST request demonstrating the edit operation:
POST /<context>/portaladmin/system/directories/testDirectory/edit HTTP/1.1
Host: organization.example.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=pjsonJSON Response example
{
"status": "success",
"recheckAfterSeconds": 10
}