SharedAccessFolders
Retrieves the list of information about the shared folders.
The add-in will use the DocuSign API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the add-in.
- FolderId supports the '=' and 'IN' operators.
- UserUserId supports the '=' and 'IN' operators.
- UserUserStatus supports the '=' operator.
- SearchText supports the '=' operator.
- Shared supports the '=' operator.
For example, the following queries are processed server side:
SELECT * FROM SharedAccessFolders
Columns
| Name | Type | References | Description |
| FolderId [KEY] | String | The ID of the folder. | |
| FolderName | String | The name of the folder. | |
| OwnerAccountId | String | Information about the user who owns the folder. The account ID associated with the folder. | |
| OwnerAccountName | String | Information about the user who owns the folder. The name on the account. | |
| OwnerActivationAccessCode | String | Information about the user who owns the folder. Access code provided to the user to activate the account. | |
| OwnerEmail | String | Information about the user who owns the folder. The user's email address. | |
| OwnerIpAddress | String | Information about the user who owns the folder. The user's ip address. | |
| OwnerLoginStatus | String | Information about the user who owns the folder. When true, indicates that the user is logged in. | |
| OwnerMembershipId | String | Information about the user who owns the folder. The user's membership ID. | |
| OwnerUri | String | Information about the user who owns the folder. A URI containing the user ID. | |
| OwnerUserId | String | Information about the user who owns the folder. The ID of the user to access. | |
| OwnerUserName | String | Information about the user who owns the folder. The name of the user. | |
| OwnerUserStatus | String | Information about the user who owns the folder. Status of the user's account. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled. | |
| OwnerUserType | String | Information about the user who owns the folder. The type of user. | |
| ParentFolderId | String | The ID of the parent folder. | |
| ParentFolderUri | String | The URI for the parent folder. | |
| Shared | String | Indicates how the folder is shared. Valid values are: shared_to, not_shared. | |
| SharedGroups | String | A list of groups that shared the folder. | |
| SharedUsers | String | A list of users who share the folder. | |
| Uri | String | A URI containing the user ID. | |
| UserAccountId | String | Information about the user associated with the folder. The account ID associated with the folder. | |
| UserAccountName | String | Information about the user associated with the folder. The name on the account. | |
| UserActivationAccessCode | String | Information about the user associated with the folder. Access code provided to the user to activate the account. | |
| UserEmail | String | Information about the user associated with the folder. The user's email address. | |
| UserIpAddress | String | Information about the user associated with the folder. The user's ip address. | |
| UserLoginStatus | String | Information about the user associated with the folder. When true, indicates that the user is logged in. | |
| UserMembershipId | String | Information about the user associated with the folder. The user's membership ID. | |
| UserUri | String | Information about the user associated with the folder. A URI containing the user ID. | |
| UserUserId | String | Information about the user associated with the folder. The ID of the user to access. | |
| UserUserName | String | Information about the user associated with the folder. The name of the user. | |
| UserUserStatus | String | Information about the user associated with the folder. Status of the user's account. One of: ActivationRequired, ActivationSent, Active, Closed, Disabled. | |
| UserUserType | String | Information about the user associated with the folder. The type of user. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| SearchText | String | Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string. |