- Home
- Resources
- Net Folders
GET /admin/net_folders
Lists Net Folders.
By default, all Net Folders are returned. To only get home directory Net Folders use the type=home query parameter.
To exclude home directory Net Folders, use the type=net query parameter.
Request Parameters
name |
type |
description |
default |
constraints |
include_full_details |
query |
If true, the NetFolder objects will include the sync_schedule and assigned_rights fields. Otherwise, those fields are not included. |
false |
boolean |
type |
query |
Can be net or home . |
|
|
Response Body
media type |
data type |
description |
application/json |
SearchResultList
(JSON) |
A SearchResultList of NetFolder objects. |
application/xml |
searchResultList
(XML) |
POST /admin/net_folders
Creates a new Net Folder.
The following Net Folder fields are mandatory in the request body:
Request Body
media type |
data type |
description |
application/json |
NetFolder
(JSON) |
The Net Folder object to create. |
application/xml |
netFolder
(XML) |
Response Codes
code |
condition |
404 |
(NET_FOLDER_SERVER_NOT_FOUND) No Net Folder Server exists with the specified ID. |
409 |
(TITLE_EXISTS) A Net Folder already exists with the specified name. |
Response Body
media type |
data type |
description |
application/json |
NetFolder
(JSON) |
The full newly-created Net Folder object. |
application/xml |
netFolder
(XML) |
DELETE /admin/net_folders/{id}
Deletes the Net Folder.
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
Response Codes
code |
condition |
204 |
The Net Folder is deleted successfully |
404 |
(FOLDER_NOT_FOUND) No Net Folder exists with the specified ID. |
GET /admin/net_folders/{id}
Retrieves a Net Folder.
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
Response Codes
code |
condition |
404 |
(FOLDER_NOT_FOUND) No Net Folder exists with the specified ID. |
Response Body
media type |
data type |
description |
application/json |
NetFolder
(JSON) |
The Net Folder with the specified ID. |
application/xml |
netFolder
(XML) |
PUT /admin/net_folders/{id}
Updates a Net Folder. Only the fields that are included in the request body are updated.
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
Request Body
media type |
data type |
application/json |
NetFolder
(JSON) |
application/xml |
netFolder
(XML) |
Response Codes
code |
condition |
404 |
(FOLDER_NOT_FOUND) No Net Folder exists with the specified ID. |
404 |
(NET_FOLDER_SERVER_NOT_FOUND) No Net Folder Server exists with the specified ID. |
Response Body
media type |
data type |
description |
application/json |
NetFolder
(JSON) |
The updated Net Folder. |
application/xml |
netFolder
(XML) |
DELETE /admin/net_folders/{id}/assigned_rights
Removes all assigned rights for the Net Folder
Request Parameters
name |
type |
description |
constraints |
id |
path |
The ID of the Net Folder. |
long |
Response Codes
code |
condition |
204 |
The rights were removed successfully. |
404 |
(FOLDER_NOT_FOUND) No Net Folder exists with the specified ID. |
GET /admin/net_folders/{id}/assigned_rights
Retrieves the assigned rights of a Net Folder.
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
Response Codes
code |
condition |
404 |
(FOLDER_NOT_FOUND) No Net Folder exists with the specified ID. |
POST /admin/net_folders/{id}/assigned_rights
Grant a user or group rights to the Net Folder. To remove rights from a user or group, set the Net Folder Access role to "NONE".
Request Parameters
name |
type |
description |
constraints |
id |
path |
The ID of the Net Folder |
long |
Response Codes
code |
condition |
404 |
(FOLDER_NOT_FOUND) No Net Folder exists with the specified ID. |
PUT /admin/net_folders/{id}/assigned_rights
Sets the Net Folder assigned rights.
Request Parameters
name |
type |
description |
constraints |
id |
path |
The ID of the Net Folder |
long |
Response Codes
code |
condition |
404 |
(FOLDER_NOT_FOUND) No Net Folder exists with the specified ID. |
DELETE /admin/net_folders/{id}/sync
Cancel the in-progess sync of the Net Folder.
By default, the in-progress sync is notified and the HTTP request completes without waiting for the sync job to exit.
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
wait |
query |
If true, the HTTP request will block until the in-progress sync cancellation is complete. |
false |
boolean |
Response Codes
code |
condition |
404 |
(FOLDER_NOT_FOUND) No Net Folder exists with the specified ID. |
GET /admin/net_folders/{id}/sync
Retrieves the Net Folder sync status.
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
Response Codes
code |
condition |
404 |
(FOLDER_NOT_FOUND) No Net Folder exists with the specified ID. |
POST /admin/net_folders/{id}/sync
Kick off a sync of the Net Folder.
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
wait |
query |
If true, the HTTP request will block until the sync completes. |
false |
boolean |
Response Codes
code |
condition |
404 |
(FOLDER_NOT_FOUND) No Net Folder exists with the specified ID. |