GET /Folders
Request a folder by folder path.
Query Parameters
| Parameter | Type | Description |
|---|
| folderpath | String | The document library path of the folder. |
| foldername | String | The name of the folder. |
Response Codes
| Code | Description |
|---|
| 400 | Bad Request |
GET /Folders/{id}
Request a folder by folder ID.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The folder id. |
GET /Folders/{id}/Folders
Request child folders by parent folder ID.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The folder id. |
GET /folders/{id}/securitymembers
Get the members of a folder by security role.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The folder id. |
PUT /Folders/{id}
Update folder properties.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The folder id. |
Body Parameters
| Parameter | Type | Description |
|---|
| name | String | The customer name. |
| description | String | Document description. |
PUT /Folders/{id}/SecurityMembers
Set the security members of a folder.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The folder id. |
Body Parameters
| Parameter | Type | Description |
|---|
| cascadeSecurityChanges | Bool | Applies the changes to all child folders of the provided folder. |
| securityActions | {SecurityMemberApplyAction} | A list of security actions to apply. |
Response Codes
| Code | Description |
|---|
| 400 | Bad Request |
PUT /folders/{id}/securitymembers/{childId}
Adds a member to a folder and optionally to all child folders.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The folder id. |
| childId* | Guid | The user id. |
Body Parameters
| Parameter | Type | Description |
|---|
| securityRole** | Int | The role type to set.- None (0)
- Owner (1)
- Editor (2)
- Publisher (3)
- Viewer (4)
- Member (5)
|
| memberType** | String | The member type to apply. |
| cascadeSecurityChanges | Bool | Applies the changes to all child folders of the provided folder. |
Response Codes
| Code | Description |
|---|
| 400 | Bad Request |
DELETE /folders/{id}/securitymembers/{childId}
Removes a member to a folder and optionally from all child folders.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The folder id. |
| childId* | Guid | The user id. |
Query Parameters
| Parameter | Type | Description |
|---|
| cascadeSecurityChanges | Bool | Applies the changes to all child folders of the provided folder. |
Response Codes
| Code | Description |
|---|
| 400 | Bad Request |
POST /folders
Create a new folder.
Creates a folder from folderPath provided or TopLevelFolder.
If no folder path provided, naming conventions and record retention maybe specified or inherit naming conventions, and record retention may be specified if providing a folder path.
Body Parameters
| Parameter | Type | Description |
|---|
| folderpath | String | The document library path of the folder. |
| name | String | The customer name. |
| description | String | Document description. |
| allowRevisions | Bool | Sets the 'Allow Revisions' status of the folder. |
| formUploadControlId | Guid | The form control ID if this call originates from an Upload Button form control. |
| formId | Guid | The form ID if this call originates from an Upload Button form control. |
| inheritNamingConvention | Bool | Sets the 'Inherit Naming Convention' setting for the folder. |
| inheritRecordRetention | Bool | Sets the 'Inherit Record Retention' setting for the folder. |
Response Codes
| Code | Description |
|---|
| 403 | Forbidden |
POST /folders/{id}
Create a child folder for the provided parent folder.
Creates a child folder of the parentfolderId provided.
Naming conventions and record retention maybe specified or inherit naming conventions, and record retention may be specified.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The folder id. |
Body Parameters
| Parameter | Type | Description |
|---|
| name* | String | The customer name. |
| description | String | Document description. |
| allowRevisions | Bool | Sets the 'Allow Revisions' status of the folder. |
| inheritNamingConvention | Bool | Sets the 'Inherit Naming Convention' setting for the folder. |
| inheritRecordRetention | Bool | Sets the 'Inherit Record Retention' setting for the folder. |
DELETE /folders/{id}
Remove a folder and all child folders.
Sets the folder status of a folder and all the child folders to 'Purged' if no documents exist in the entire branch.
Sets the folder status of a folder and all the child folders to 'Deleted' if there are documents in the folder branch.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The folder id. |
GET /folders/{id}/documents
Get all documents from a folder.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The folder id. |
Query Parameters
| Parameter | Type | Description |
|---|
| metaonly | Bool | Return only index field metadata. |
| includesubfolders | Bool | Also retrieve the documents from any subfolders. |
| offset | String | Sets an offset to the start of the search. |
| limit | Int | Sets a limit to the number of values returned. |
| sort | String | The name of a data column to sort by. |
| sortDir | String | Sort direction.- asc: Ascending order
- desc: Descending order
|
| q | String | A VisualVault REST API Data Query. |
Response Codes
| Code | Description |
|---|
| 400 | Bad Request |
GET /folders/{id}/indexfields
Returns all folder index fields.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The folder id. |
Query Parameters
| Parameter | Type | Description |
|---|
| metaonly | Bool | Return only index field metadata. |
| formControlId | Guid | Id of the form control requesting the index fields if called from a form. |
| formId | Guid | Id of the form requesting the index fields if called from a form. |
GET /folders/{id}/indexfields/{childId}
Returns the specified index field for a folder.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The folder id. |
| childId* | Guid | The index field id. |
Query Parameters
| Parameter | Type | Description |
|---|
| metaonly | Bool | Return only index field metadata. |
PUT /folders/{id}/indexfields/{childId}
Update a folder index field.
Updates a folder index field to override the global index field definition, or to remove the override setting.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The folder id. |
| childId* | Guid | The index field id. |
Body Parameters
| Parameter | Type | Description |
|---|
| overriden | Bool | Sets the index field 'Override' setting. |
| queryId* | Guid | The query ID. |
| queryValueField* | String | The value to assign. |
| queryDisplayField* | String | The value to display. |
| dropDownListId* | Guid | The drop down list ID. |
| required | Bool | Sets the index field 'Required' status. |
| defaultValue | String | Sets the default value of the index field. |
GET /folders/{id}/indexfields/{childId}/selectOptions
Return the select options of a dropdown list or other datasource-driven index field.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The folder id. |
| childId* | Guid | The index field id. |
POST /folders/copy
Copy a folder to a new location.
Body Parameters
| Parameter | Type | Description |
|---|
| sourceFolderId | Guid | Folder ID of the folder to be copied. |
| sourceFolderPath | String | Folder path of the folder to be copied. |
| targetFolderId | Guid | Folder ID of the destination folder to copy to. |
| targetFolderPath | String | Folder path of the destination folder to copy to. |
PUT /folders/move
Move a folder to a new location.
Body Parameters
| Parameter | Type | Description |
|---|
| sourceFolderId | Guid | Folder ID of the folder to be copied. |
| sourceFolderPath | String | Folder path of the folder to be copied. |
| targetFolderId | Guid | Folder ID of the destination folder to copy to. |
| targetFolderPath | String | Folder path of the destination folder to copy to. |
GET /folders/{id}/alerts
Get all subscriptions for folder alerts.
No Parameters.
POST /folders/{id}/alerts/{eventId}
Subscribe a user to a folder alert.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The folder id. |
| eventId* | Guid | The event id. |
Query Parameters
| Parameter | Type | Description |
|---|
| usId* | Guid | UsId of the associated user. |
Response Codes
| Code | Description |
|---|
| 400 | Bad Request |
DELETE /folders/{id}/alerts/{eventId}
Remove a user subscription from a folder alert.
Route Parameters
| Parameter | Type | Description |
|---|
| id* | Guid | The folder id. |
| eventId* | Guid | The user id. |
Query Parameters
| Parameter | Type | Description |
|---|
| usId* | Guid | UsId of the associated user. |
Response Codes
| Code | Description |
|---|
| 400 | Bad Request |
| 404 | Not Found |