Reference Documentation for the Filr Administration REST Interface

Resources

There is a WADL document available that describes the resources API.

name path methods description
Admin Root
  • /admin
  • GET
Returns links that can be used to navigate the Admin REST APIs.
Desktop Application
  • /admin/desktop_application
  • GET, PUT
 
LDAP User Sources
  • /admin/user_sources
  • /admin/user_sources/sync
  • /admin/user_sources/sync_config
  • /admin/user_sources/{id}
  • GET, POST
  • POST
  • GET, PUT
  • DELETE, GET
 
Net Folder Servers
  • /admin/net_folder_servers
  • /admin/net_folder_servers/{id}
  • /admin/net_folder_servers/{id}/net_folders
  • GET, POST
  • DELETE, GET, PUT
  • GET, POST
 
Net Folders
  • /admin/net_folders
  • /admin/net_folders/{id}
  • /admin/net_folders/{id}/sync
  • GET, POST
  • DELETE, GET, PUT
  • DELETE, GET, POST
 
Personal Storage
  • /admin/personal_storage
  • GET, PUT
 
Share Settings
  • /admin/share_settings
  • /admin/share_settings/external_restrictions
  • /admin/share_settings/permissions
  • GET, PUT
  • GET, PUT
  • DELETE, GET, POST, PUT
 
Shares
  • /admin/shares
  • /admin/shares/public
  • /admin/shares/{id}
  • GET
  • GET
  • DELETE, GET
 
Web Application
  • /admin/web_application
  • GET, PUT
 

Data Types

JSON

type description
Access The access a user or group has to a resource.
AssignedRight A right that has been assigned to a recipient.

The recipient can be a user or a group.
AssignedSharingPermission The sharing permissions that have been granted to a recipient.

The recipient can be a user or a group.
BaseRestObject A base class for many of the REST data types.
DesktopAppAdminConfig The desktop application system settings.
EntityId An ID, type and HRef which references another resource object.
ExternalSharingRestrictions Restrictions for sharing with external users.
GroupSynchronization The LDAP group synchronization settings.
KeyValuePair A generic key/value pair.

Used to represent LDAP attribute mappings in LDAP User Source configurations
LdapHomeDirConfig Configuration defining how home directory net folders are created for users that are imported from LDAP.
LdapSearchInfo An LDAP container to search for users or groups.
LdapSyncResults The results of performing an LDAP sync.
LdapUserSource An LDAP server that servers as a source for users and groups.
Link A link to a related resource.
LongIdLinkPair An ID and HRef which references another resource object.
NetFolder The metadata of a Net Folder
NetFolderServer The metadata of a Net Folder Server
NetFolderSyncStatus The current sync status of a Net Folder.
PersonalStorage The Personal Storage settings.
Recipient A reference to a user or group that is the recipient of a share or assigned permission.
RootAdminObject Root object of the REST Admin API. Contains related links to top level resources in the REST API.

Related link names include: desktop_application, net_folder_servers, net_folders, personal_storage, public_shares, shares, share_settings, user_sources, user_source_sync, user_source_sync_config, web_application.
Schedule A schedule.
SearchResultList A list of paged results.
SelectedDays The selected days on which a schedule will activate.
Share Information about a file or folder that has been shared.
ShareRecipient Reference to the recipient of a shared item.

Type can be one of user, group. external_user, public. public_link. If type is public or public_link, ID and hrek are not applicable.

ShareSettings Global Share Settings.
SharingPermission Sharing permissions
Time A time used in Schedules. This can be either an absolute time (at 14:00) or an interval (every 0 hours and 30 minutes).

For absolute times, the minute value is restricted to every 5 minutes (00, 05, 10, ..., 55). Intervals are restricted to 0:15, 0:30, 0:45, 1:00, 2:00, 3:00, 4:00, 6:00, 8:00 and 12:00.

UserSourceSynchronization The general LDAP User Source synchronization settings that apply across all LDAP Sources.
UserSynchronization The LDAP User synchronization settings.
WebAppConfig The Web Application settings.

XML

Default Namespace (schema)
type description
access The access a user or group has to a resource.
baseRestObject A base class for many of the REST data types.
entityId An ID, type and HRef which references another resource object.
externalSharingRestrictions Restrictions for sharing with external users.
link A link to a related resource.
longIdLinkPair An ID and HRef which references another resource object.
recipient A reference to a user or group that is the recipient of a share or assigned permission.
searchResultList A list of paged results.
share Information about a file or folder that has been shared.
shareRecipient Reference to the recipient of a shared item.

Type can be one of user, group. external_user, public. public_link. If type is public or public_link, ID and hrek are not applicable.

sharingPermission Sharing permissions
assignedRight A right that has been assigned to a recipient.

The recipient can be a user or a group.
assignedSharingPermission The sharing permissions that have been granted to a recipient.

The recipient can be a user or a group.
desktopAppAdminConfig The desktop application system settings.
groupSynchronization The LDAP group synchronization settings.
keyValuePair A generic key/value pair.

Used to represent LDAP attribute mappings in LDAP User Source configurations
ldapHomeDirConfig Configuration defining how home directory net folders are created for users that are imported from LDAP.
ldapSearchInfo An LDAP container to search for users or groups.
ldapSyncResults The results of performing an LDAP sync.
ldapUserSource An LDAP server that servers as a source for users and groups.
netFolder The metadata of a Net Folder
netFolderServer The metadata of a Net Folder Server
netFolderSyncStatus The current sync status of a Net Folder.
personalStorage The Personal Storage settings.
rootAdminObject Root object of the REST Admin API. Contains related links to top level resources in the REST API.

Related link names include: desktop_application, net_folder_servers, net_folders, personal_storage, public_shares, shares, share_settings, user_sources, user_source_sync, user_source_sync_config, web_application.
schedule A schedule.
selectedDays The selected days on which a schedule will activate.
shareSettings Global Share Settings.
time A time used in Schedules. This can be either an absolute time (at 14:00) or an interval (every 0 hours and 30 minutes).

For absolute times, the minute value is restricted to every 5 minutes (00, 05, 10, ..., 55). Intervals are restricted to 0:15, 0:30, 0:45, 1:00, 2:00, 3:00, 4:00, 6:00, 8:00 and 12:00.

userSourceSynchronization The general LDAP User Source synchronization settings that apply across all LDAP Sources.
userSynchronization The LDAP User synchronization settings.
webAppConfig The Web Application settings.