Edit (Directory)

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

ParameterDetails

physicalPath

The new path for the directory.

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
physicalPath={
  "type": "fileStore",
  "provider": "FileSystem",
  "connectionString": "//server/share/content",
  "isConnectionStringEncrypted": false
}

description

The new description for the directory.

Example
Use dark colors for code blocksCopy
1
description=The content directory.

f

The response format. The default is html.

Values: html | json | pjson

Example usage

The following is a sample POST request demonstrating the edit operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
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=pjson

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
{
  "status": "success",
  "recheckAfterSeconds": 10
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.