API Test Harness

Login functions

gettoken - Get token for operations. We suggest to use POST for this function, this will hide user login and password. It supports also special auth values: if us_login is `TEMPAUTHTOKEN` then us_pwd can be a token generated by the API function getTempAPILoginToken

GET

Name	Default	Value	Description
us_login			Nasuni Access Anywhere Server login
us_pwd			Nasuni Access Anywhere Server password

logOut - Complete the API session. This function destroys the API token. It is optional. If a token is not used then it will be autodestroyed in 1 hour after last call.

GET

getTempAuthToken - Get temporary authentication token.

GET

Token for this function is *

Get temporary authentication token. In this function the token must have the value “*”.

This function is used to get temporary authentication token (valid for 1 hour) which may be changed to permanent token which is valid for 1 year and may be used to get token.

Success response parameters:

token - contains the temporary authentication token
type - always “temporary”
endon - life time timestamp
authurl - the url where user must be redirected in browser in order to login and authorize authentication token.

Authentication token applications use flow:

Application is using getTempAuthToken API function to get temporary authentication token and authurl.
Application is opening browser with authurl URL (authurl URL must contain Nasuni Access Anywhere Server user login).
Application is using getAuthTokenStatus API function to get status of temporary authentication token [function will return permanent authentication token once it will be available] in loop with some delay after every use.
Application is getting permanent (valid for 1 year) authentication token as getAuthTokenStatus API function response and after thismay use getTokenByAuthToken API function to get token.

Params

Name	Default	Description
tool		Name of tool (app) which suppose to use authentication token.
description		Description of authentication token (for what it will be used).
autologin	n	Return autologin code in result. Possible values are "y" or "n".

Response:

getAuthTokenStatus - Get temporary authentication token status.

GET

Token for this function is *

Get temporary authentication token status. In this function the token must have the value “*”.

This function is used to get permanent authentication token (valid for 1 year) by temporary authentication token (valid for 1 hour) once user will authorize temporary authentication token.

Success response parameters:

ready - is permanent token ready or no: “y” or “n”
token - authentication token [this field will contain new permanent token in case if user already authorized temporary authentication token]
type - type of returned token
endon - returned token life time timestamp

Authentication token applications use flow:

Application is using getTempAuthToken API function to get temporary authentication token and authurl.
Application is opening browser with authurl URL (authurl URL must contain Nasuni Access Anywhere Server user login).
Application is using getAuthTokenStatus API function to get status of temporary authentication token [function will return permanent authentication token once it will be available] in loop with some delay after every use.
Application is getting permanent (valid for 1 year) authentication token as getAuthTokenStatus API function response and after thismay use getTokenByAuthToken API function to get token.

Params

Name	Default	Value	Description
temptoken			Temporary authentication token.

Response:

getTokenByAuthToken - Get token by permanent authentication token.

GET

Name	Default	Value	Description
authtoken			Permanent authentication token.

getPermissions - Returns permissions for user.

GET

getRegistrationForm - Returns data used for the registration of new users.

GET

doRegistration - Process registration.

GET

Token for this function is *

Process registration. Function getRegistrationForm must be called before this function to get captcha session id.

Success response parameters:

The function returns nothing, Just ‘success’ or error description.

Params

Name	Default	Description
us_name		us_name
us_login		us_login
us_pwd		us_pwd
us_email		us_email
key		key
us_slevel		us_slevel
captcha_sessionid		captcha_sessionid
invcode		invcode
us_phone		User phone
discountcode		discountcode
orgid	0	orgid
sendactivationemail	y	Send activation email
policiesaccepted		Is policies accepted by user or not. This param must be list of accepted policy names, separated by comma.
residency		Residency
subscriptions		Subscriptions
grinvcode		External user invitation code

Response:

doActivation - Process registration activation.

GET

Name	Default	Value	Description
activationcode			activationcode

doResendActivation - Process the resending of the activation email.

GET

Name	Default	Value	Description
us_login			us_login
us_pwd			us_pwd
us_email			us_email

setProviderData - Sets external cloud provider login info for the session if this info were not saved.

GET

Sets external cloud provider login info for the session if this info were not saved. This function is called after user logged in to the service. It is needed to call this function for each user's provider that has no login/password saved.

Success response parameters:

This function returns status (success or error description). Also it returns node 'notice'=1 if there are more providers in account that must be inited for the session.

Params

Name	Default	Value	Description
pi_login			pi_login
pi_password			pi_password
pi_id			pi_id
saveinfo			'y' or 'n' . Save credentials in StorageMadeEasy or not. If 'y' then credentials will be encrypted and saved in StorageMadeEasy and user will not need to enter it again. If not provided then it is equeal to 'n'

You must log in to be able to check this function execution.

Response:

getUserInfo - Returns the current user information.

GET

updateUsersData - Update user account data.

GET

setNewUserPassword - Update a user's account password.

GET

Name	Default	Value	Description
us_pwd			us_pwd
newpassword			newpassword

setNewUserEmail - Update a user's account email.

GET

This function is used to update a user's account email. This function must be called 2 times. First to send the email verification message, and the second call is confirming the email with a code. Also there is 3-rd mode of this function to check if there was set a new email for verification. How it works: Call this function with step=3 and data=new user email. Email message will be send to this email with confirmation code in the body. Ask the user to copy that code and provide to application. Then call this function again with step=2 and data=confirmation code. Email will then be changed.

Success response parameters:

Status data

Params

Name	Default	Value	Description
step			1, 2 or 3. 1 to set new email and send verification message, 2 to enter verification code, 3 to return email if it was set for verification.
data			if step is 1 then this argument is new user email. If step is 2 then this argument is confirmation code. If step is 3 then this argument is not used.

You must log in to be able to check this function execution.

Response:

setNewUserLogin - Change loginname (username) for existent user.

GET

Name	Default	Value	Description
newlogin			newlogin
us_pwd			us_pwd

checkNewUserLogin - Check if login name exists.

GET

Name	Default	Value	Description
newlogin			newlogin
orgid			Organization ID that this user is member of (0 for single users). If is not set then Org ID of current loged in user will be used.

updateAccountOptions - Update user account options.

GET

Name	Default	Value	Description
data			Data in such format: key1=value1key2=value2.... Where is "\n" symbol
format			Format of data, can be blank or equal to base64 if values in data param are base64 encoded.

getTempAPILoginToken - returns short living temporary token to start new API session with it. It can be used to auth some parallel process to work with API. The token can be exchanged for a normal API token with the API function getToken

GET

getPersonalInformation - Returns all Pii data for the user.

GET

Name	Default	Value	Description
filter			Specifies which type of data to return. Comma separated list of options. Possible options: contact, email, location, policy, usage
format			Specifies format of data to return. Possible values: xlsx, pdf, html. If empty then response will be in JSON or XML format.

getActiveSessions - Return list of active sessions and devices. Note that in se_id can be comma separated list of session IDs.

GET

Name	Default	Value	Description
us_id			ID of user that is owner of the sessions. Leave empty if you want to get sessions of current user.

revokeSession - Revoke active session.

GET

Name	Default	Value	Description
se_id			Session ID or comma separated list of session IDs. Can be get by getActiveSessions.
us_id			ID of user that is owner of this session. Leave empty if you want to revoke session of current user.

Cloud File functions

getFilesList - Return all files and sub-folders in a given folder.

GET

Return all files and folders with all attributes. Also returns all tags.

Success response parameters:

XML structure with data of the database tables Files and Tags. Also includes filter data and some statistics (total amount of files/folders, amount of filtered files/folders). Also there is node 'refreshresult' that contains response of function resyncFolder. This node can be used to get information about folder cache state.

Params

Name	Default	Description
fi_id	0	fi_id
limitlonglists	0	This argument must be set to 1 if it is required to not load files list when it is too long (to many files) and filter is not set
ignorefilter	n	'y' or 'n'. If missed then is 'n'. If is 'y' then all files are loaded even if filter is set
commentstatus	n	'y' or 'n'. If is 'y' then for every file count of comments will be returned in response.
includeversions	n	Include versioned files. 'y' or 'n'. If this argument is provided then it overrides user's settings for versioned files vieving
orderby		Field to order results. Allowed values are: fi_name, fi_extension, fi_type, fi_created, fi_size. Also every of allowed values can be used together with DESC suffix. Example, fi_name DESC - means sort by name in descending order. If you don't want to sort result then use value: nothing
versions_status	n	'y' or 'n'. If 'y' then for each file count of versions will be returned in response
subfolders	n	Show count of subfolders. 'y' or 'n'. If is 'y' then for every subfolder count of subitems will be returned. This can be used for knowing of subfolder has something (files/folders) or not
refresh	n	Refresh folder. (optional) 'y' or 'n'. If 'y' then folder will be refreshed before data are loaded and returned with response. See function resyncFolder. If this argument is 'n' then folder is not refreshed. If this argumenst is empty then account settings are checked (option Real-Time refresh is used)
refreshtype	s	Refresh type. 's' or 'a'. If is 's' then folder will be refreshed realtime. Response will not be returned while refresh is not completed. If is 'a' then folder will be refreshed asynchronously. Response will be returned immediately and refresh will work at background
sharingstatus	n	Return share status. Possible values are 'y' or 'n'.
lastmodified		Reserved. Not used yet.
options		Return options. Possible values for tags to return: all_tags, filterinfo, filelist, stats, spaceinfo, refreshresult, tagslist, tagcloud. Possible values for file fields to return: basic_fields, all_fields or any set of file fields. Values are separated by '\|' symbol, for example: filelist\|tagslist\|basic_fields or filelist\|tagslist\|fi_id\|fi_pid or fi_id\|fi_name . May contain option `comments`. If this option is present then each file will have field commented. If this field is 0 then file has no comments. If this field is 1 then a file has comments. May contain option `locked`. If this option is present then each file will have field locker. If locker field is 0 then file is not locked. If this field is not 0 then a file is locked by user with locker id. May contain option `folderencrypted`. If this option is present then each folder will have field encrypted. If this field is 0 then folder is not encrypted. If this field is 1 then a folder has encryption phrase. May contain option `folderlinks`. If this option is present then each folder will have field links. If this field is 0 then folder has no links. If this field is 1 then a folder has links. May contain option `content_detection`. If this option is present and account have Content Detection support then each file will have field content_detection. If this field is 0 then file has not tagged as Content Detection. If this field is more than 0 then a file is tagged as Content Detection, a folder have Content Detection files inside. If options param is empty then all_tags\|all_fields is used.
from	0	Starts from. Integer value that says from what number to list items. This can be used for limiting of count of returned items for folders with long files list. If is not set than items are listed from first item.
count	10000	Count of items to return. If is set then list will be truncated to this count.

You must log in to be able to check this function execution.

Response:

getFolderContents - Return all files and sub-folders in a given folder with all attributes.

GET

Return all files in a given folder with all attributes.

Success response parameters:

List of files. Also there is node 'refreshresult' that contains response of function resyncFolder. This node can be used to get information about folder cache state.

Params

Name	Default	Description
fi_pid	0	fi_pid
from		Starts from. Integer value that says from what number to list items. This can be used for limiting of count of returned items for folders with long files list. If is not set than items are listed from first item
count		Count of items to return. If is set then list will be truncated to this count
fi_type		Type of items. If is not set then both files and folders are returned . If 1 then only subfolders are returned. If 0 then only files are returned
showpath	n	Show path. 'y' or 'n'. If 'y' then for every file/folder full path will be generated and returned in result
orderby		Field to order results. Allowed values are: fi_name, fi_extension, fi_type, fi_created, fi_size. Also every of allowed values can be used together with DESC suffix. Example, fi_name DESC - means sort by name in descending order. If you don't want to sort result then use value: nothing
includeversions	n	Include versioned files. 'y' or 'n'. If this argument is provided then it overrides user's settings for versioned files vieving
subfolders	n	Show count of subfolders. 'y' or 'n'. If is 'y' then for every subfolder count of subitems will be returned. This can be used for knowing of subfolder has something (files/folders) or not
refresh		Refresh folder. (optional) 'y' or 'n'. If 'y' then folder will be refreshed before data are loaded and returned with response. See function resyncFolder. If this argument is 'n' then folder is not refreshed. If this argumenst is empty then account settings are checked (option Real-Time refresh is used)
refreshtype		This argument is not used anymore. Just leave it empty
sharingstatus	n	Returns sharing status of every file/folder in folder. If this is 'y' then for every item there will be additional field 'isshared' with value 1 or 0
lockedstatus	n	Returns lock status of every file in folder. If this is 'y' then for every file there will be additional field 'locker' with value 0 or ID of a user that locked the file
lastmodified		Reserved. Not used yet.
options		Return options. Possible values for tags to return: all_tags, filelist, folder, parents, refreshresult, curfolder. Possible values for file fields to return: basic_fields, all_fields or any set of file fields. Values are separated by '\|' symbol, for example: folder\|parents\|basic_fields or fi_id\|fi_pid. May contain option `comments`. If this option is present then each file will have field commented. If this field is 0 then file has no comments. If 1 then a file has comments. May contain option `folderencrypted`. If this option is present then each folder will have field encrypted. If this field is 0 then folder is not encrypted. If 1 then a folder has encryption phrase. May contain option `folderlinks`. If this option is present then each folder will have field links. If this field is 0 then folder has no links. If 1 then a folder has links. May contain option `content_detection`. If this option is present and account have Content Detection support then each file will have field content_detection. If this field is 0 then file has not tagged as Content Detection. If this field is more than 0 then a file is tagged as Content Detection, a folder have Content Detection files inside. May contain option `relatedcounts` - if present, will return number of versions and number of related files per file If options param is empty then all_tags\|all_fields is used.

You must log in to be able to check this function execution.

Response:

getListOfFiles - Return all files in a given folder with all attributes with chunks. Can be used to load big set of files with few steps.

GET

Return all files in a given folder with all attributes with chunks. Can be used to load big set of files with few steps.

Success response parameters:

List of files. Node 'truncated' says if list was truncated or not. If 'truncated' = 1 then list of files was truncated and it is needed to call this function again and value of first argument should be id or path of last file in list of received files.

Params

Name	Default	Description
marker		last received file (ID or Path, see second argument). If list should be returned from beginning then this argument is 0 or empty. If request is done to get next part of list then this value identifies last file in previous list.
markettype		Marker type - can have 2 possible values - 'id' and 'path' . If 'id' then value of first argument is id of last loaded file. If this value is 'path' then first argument is full path of last loaded file.
limit	1	Count of files to load - integer value from 1 to 1000
includefolders	n	Include folders - 'n' or 'y'. If 'n' then only files will be in the list
fi_pid	0	Id of root folder to load contents from. If 0 then all files in account will be returned. If this value is id of existent folder then only content of the folder will be returned.

You must log in to be able to check this function execution.

Response:

doMoveFiles - Move files to another folder.

GET

Name	Default	Value	Description
fi_ids			fileid
dir_id			folderid

doRenameFile - Rename file and allow to change the description and tags

GET

Rename file or change attributes (description,tags)

Success response parameters:

Altered file info

Params

Name	Default	Description
fi_id		ID of the file
fi_name		Name of the file
fi_description		Description of the file
fi_tags		Tags of the file
metadata	0	File metadata in format metadataID=value1metadataID=value2.... Where is "\n" symbol.
returntagcloud	n	If this argument is `y` then on success response the tag cloud will be included in response.
overwrite	n	If this argument is `y` then existing file will be overwritten if needed. Example, exists two files in the same folder: 1) file1.docx 2) file2.docx You try to rename `file1.docx` to `file2.docx` and this argument is `y`. In this case `file2.docx` will be moved to the trash or removed if trash disabled. The file `file1.docx` will be renamed to `file2.docx`.

You must log in to be able to check this function execution.

Response:

doModifyFile - Change file attributes. Any attributes , exclude fi_id and fi_uid can be changed

GET

doDeleteFile - Delete file

GET

Delete file

Success response parameters:

Just status

Params

Name	Default	Description
fi_id		File ID or comma separated list of file ids
returntagcloud	n	If this argument is `y` then on success response the tag cloud will be included in response.
tagcloudtype		If returntagcloud=y then tagcloudtype must specify type of the tag cloud. Supported types: html
completedeletion	n	If this argument is `y` then it means that file should be deleted completely when impossible to move it to trash. Set this param to `y` only if user confirmed that he really want to delete this file completely. The behavior should be like this: - user try to move file to Trash - tool send doDeleteFile request - API return error "can_delete_only_completely", because file cannot be moved to the Trash - tool ask confirmation to delete file completely - user confirm that he really want to delete this file completely - tool send doDeleteFile again. But, now with param "completedeletion=y" - API delete file completely

You must log in to be able to check this function execution.

Response:

doUploadFiles - Upload files.

POST

Upload file.
This is the request that need arguments that are passed with the POST method. Form action URL to upload the file is: http://storagemadeeasy.com/api/1a3c5b2c5e64d5ecb56df380871594dc/doUploadFiles/ where 1a3c5b2c5e64d5ecb56df380871594dc is user access token, also this function can be used for upload to shared folders with uploading permissions for anonymous users. You can use token '*' for anonymous users.

Success response parameters:

The function returns file info

Params

Name	Default	Description
fi_pid		Parent folder id. If empty then is uploaded to root folder.
fi_structtype		Structure type (see Structures). If not important, then set this parameter to 'g'
file_name1		File 1 name.
file_desc1		File 1 description.
file_tags1		File 1 tags (comma separated).
file_modified1		File 1 modification time
file_metadata1		File 1 metadata. File metadata in format metadataID=value1metadataID=value2.... Where is "\n" symbol.
file_1		File 1.
share_gr_id	0	ID of a group to share new file with. If 0 or nothing then no any share is done
share_us_id	0	ID of a user in the group specified with the argument `share_gr_id` to share new file with. If 0 then a file is shared to a group (if `share_gr_id` is set )
fi_code		Code of shared folder to upload, can be used ONLY with token equal to *
password		Password for shared folder access

You must log in to be able to check this function execution.

Response:

getFile - Download file.

GET

Response:

If file exists then the response is actually the file. If file doesn't exist then HTTP/1.1 404 Not Found response is returned.

Params

Name	Default	Description
fi_id		File ID. This value can be also path of a file (as a string). For example, `My Amazon S3 files/bucket/folder/file.docx`.
encryptphrase		Encryption phrase.
justpart	n	If `y` and file is chunked then it will return only one chunk.
getbackup	n	If `y` and file have backup then it will return backup of the file.
thumbnail		If you want to get a thumbnail for the file then set a thumbnail width in pixels.
supportdirect	n	If a tool supports direct download then set `y`.
supportchunking	n	If a tool supports "Transfer-Encoding: chunked" then set `y`.
backupfileid		If `getbackup` is `y` then here you can set the backup file id.
forcedownload	n	If `y` then it will add `Content-Disposition` header.
downloadpassword		If download file from a Drop Folder then set password from the Drop Folder.
fi_code		If download file from a Shared Folder then set folder code (fi_code).
fi_filecode		If download shared file then set file code (fi_filecode).

You must log in to be able to check this function execution.

Response:

getFileFullInfo - Returns full info for the file. Including geo info.

GET

Name	Default	Value	Description
fi_id			file ID

getFilesInfo - Returns list of files. The list is specified with only one argument - comma separated list of ids.

GET

Name	Default	Value	Description
fi_id			file Ids list (comma separated).
showpath	n		Show path for returned files. Possible values are 'y' or 'n'.

checkPathExists - Check if file/folder path exists and returns file/folder id.

GET

Name	Default	Value	Description
path			file/folder path
pid			base folder id

doCheckEncryptionPhrase - Checks if the encryption phrase is correct for the file.

GET

Name	Default	Value	Description
fi_id			file ID
encryptphrase			encryption phrase

doInitUpload - Prepare info for uploading of new files. This function receives file data and checks it.

GET

Prepare info for uploading of new files. This function receives file data and checks it. This function can be used for upload to shared folders with uploading permissions for anonymous users. You can use token '*' for anonymous users.

Success response parameters:

The function returns uploading code. This code is important and must be used in uploading form and in doCompleteUpload function. Also the function returns the node 'resumeallowed'. It defines if user can resume uploading (when uploading fails or user paused).

Params

Name	Default	Description
fi_name		name of the file
fi_description		description of the file
fi_tags		tags
fi_pid		id of the parent folder
fi_filename		real file name
responsetype		response type
responsedata		Response data
encryptphrase		Encryption phrase
isencrypted		Reserved. This argument is not used yet. Just leave it always empty
fi_structtype		structure type code
fi_id		id of the file
chunkifbig	n	'y' or 'n'. Chunk or not
fi_localtime		file local time in format 'YYYY-MM-DD hh:mm:ss'
provider		Provider ID
comment		Comment which will be added to file.
directuploadsupport	n	If this argument is `y` then possibility of directupload will be checked. If direct upload is supported for relevant provider then direct upload data are returned. read more in Direct Upload section.
fi_size	0	Size of file to be uploaded. This is required only if argument `directuploadsupport` is `y`
fi_modified		File modification time in format 'YYYY-MM-DD hh:mm:ss'.
metadata		File metadata in format metadataID=value1metadataID=value2.... Where is "\n" symbol.
fi_code		Code of shared folder with uploading permissions.
password		Access password of shared folder with uploading permissions.
reserved1		Reserved argument. Leave it empty.
reserved2		Reserved argument. Leave it empty.
reserved3		Reserved argument. Leave it empty.
mstreamuploadsupport	n	Set "y" if you want to use MStream upload.
mstreamuploadstreams		Number of stream that you want to use for MStream upload.

You must log in to be able to check this function execution.

Response:

doInitMassUpload - Prepare info for uploading of new files. This function receives files data and checks it. We suggest to use POST for this function because data param can be long.

POST

Name	Default	Value	Description
data			JSON string of files like objects array. Every file object contain same fields like doInitUpload params

doCompleteUpload - Complete files uploading procedure. This function does the final work on file uploading.

GET

Complete files uploading procedure. This function does the final work on file uploading.

Success response parameters:

The function returns uploads file data.

The node 'file' contains new file object

Versioning

If a file with such name existed in the upload destination, the 'versioning' proces will be done. Old file is renamed to timestamped name and it becomes a version of new uploaded file. New uploaded file will keep ID of previous version and old version will get new ID.

During upload with versioning the file has temporary name on a storage. After upload the old version is renamed and new file is renamed to final name. There can be failuers during this process. The property 'version_status' containes the status of the process:
- versioned - all went success;
- rename_fail - old version was timestamped success but just uploaded file can not be renamed to requested name. The result file will keep the timestamped name with the unique code added before the extension;
- conflict - previous version rename failed. It will keep previous name (same as requested for this upload) and new uploaded file will have the timestamped name or the name starting with CONFLICT-... (in case if rename of this file was success)

Params

Name	Default	Description
uploadcode		Uploading code that was returned with function doInitUpload
reserved1		Reserved argument. Leave it empty.
reserved2		Reserved argument. Leave it empty.
reserved3		Reserved argument. Leave it empty.
options		Options (splitted with \| ). Supported options are: lockedstatus - forces to return lock status for just uploaded file to know if file is locked or not (in case if this was updating of existent locked file), directupload - means the function is called to complete direct upload. In this case argument fi_size is mandatory. read more in Direct Upload section.
fi_size	0	Uploaded file size. This is required when the function is called to complete direct uploading.
storageip		IP of the server where file was stored. This is used only when the function is called to complete direct uploading.
remotetime		Timestamp of new uploaded file on storage server. This is used only when the function is called to complete direct uploading.
remoteid		ID of just uploaded file on storage server (not needed for Amazon S3). This is used only when the function is called to complete direct uploading.
remoteresponse		Response of the server on a direct uploading. This can be used fro some providers to check if teh upload was corerct ro not in case if the tool can not do this check
share_gr_id	0	ID of a group to share new file with. If 0 or nothing then no any share is done
share_us_id	0	ID of a user in the group specified with the argument `share_gr_id` to share new file with. If 0 then a file is shared to a group (if `share_gr_id` is set )
fi_code		fi_code of shared folder
password		password of shared folder
relates	0	File ID. If file ID present then the current file will be marked as related file of the file with this ID.

You must log in to be able to check this function execution.

Response:

doCompleteMassUpload - Complete files uploading procedure. This function does the final work on file uploading. We suggest to use POST for this function because data param can be long.

POST

Name	Default	Value	Description
data			JSON string of files like objects array to complete. Every file object contain same fields like doCompleteUpload params

doAbortUpload - Abort files uploading procedure. This function should be used when user cancel upload.

GET

getUploadStatus - Get uploading status while uploading is in progress.

GET

getUploadStatusOnFail - Get uploading status when uploading failed (or stopped by user) and the user wants to continue.

GET

doBackupFiles - Processese a file backup if a file's provider has a ackup provider assigned to it. If provider has no backup then nothing will happen. Backups are done automatically when a re-sync of the primary provider occurs.

GET

Name	Default	Value	Description
fi_ids			comma separated list of files

doSearchFiles - Searches files, even if the files are stored on different cloud providers.

GET

Searches files, even if the files are stored on different cloud providers.

Success response parameters:

The function returns the list of found files.

Params

Name	Default	Description
search		search string
options		options (see above)
includeshared	n	''y' or 'n'
onlyids	n	''y' or 'n'
showfilepath	n	''y' or 'n'
type	n	Type of condition. Possible values are 'e', 'a' or 'o'. 'e' - exact phrase, 'a' all words must be found (AND condition), 'o' one of words must be found (OR condition)

You must log in to be able to check this function execution.

Response:

getFilesByQuickFilter - This function returns the list of files with filter. It is sometimes need to show a group of files by type or share state ect.

GET

This function can be used to search files.

Success response parameters:

The function returns the list of found files.

Params

Name	Default	Description
fi_pid		Id of folder where to search. If it is blank (empty) or not set then search will be done in all folders. This param can be the list of IDs separated by comma if a search must be done in more then one folder.
from		Lists starts from. This is number of item to list files from. Can be used to limit list of returned files.
count	500	Count of itens to return. If is not set (empty) then first 500 found with filter files will be returned. This param can not be more than 500.
fi_name		Filter file by name. This can be part of file name or content in specific type of search. This param could be used in the most types of searches.
fi_extension		File extension. Comma separated list of file extensions to filter with. If is not set then no filter by extension. This param must be used with search by file extension (type=x) only.
fi_description		File description. This can be part of file description. If is not set then no filter by description. This option will not take any effect if type param is equal to v , n, c, i or h.
fi_public	0	File public - 0 or 1. If is not set (empty) then no filter by this value. This option will not take any effect if type param is equal to v , n, c, i or h.
fi_provider		Id of provider. If is not set (empty) then no filter by this value. This option will not take any effect if type param is equal to v , n, c, i or h.
fi_encrypted		File encrypted - 0 or 1. If is not set (empty) then no filter by this value. This option will not take any effect if type param is equal to v , n, c, i or h.
fi_structtype		Struct type. If is not set (empty) then no filter by this value. This option will not take any effect if type param is equal to v , n, c, i or h.
fi_favorite		Is favorite - 0 or 1. If is not set (empty) then no filter by this value. This option will not take any effect if type param is equal to v , n, c, i or h.
includefolders	n	Include folders in search results or no. Possible values are 'y' or 'n'. If y then folders mached with filter will be also returned in search result. This option will not take any effect if type param is equal to v, n, c, i or h.
showpath	n	Return path. Possible values are 'y' or 'n'. If y then for every file full path will be returned.
fi_tags		File tags. Tags to search file with, tags must be separated by comma.
orderby		Ordering field. Possible values are "fi_pid", "fi_name", "fi_extension", "fi_type", "fi_created", "fi_size". Order by "score" can be used with advanced search (type=v) only.
includesubfolders	n	Search in subfolder of folder with id equal to fi_pid param or search in folder with id equal to fi_pid param only. Possible values are 'y' or 'n'. This value is ignored if fi_pid is blank (empty) or not set.
includeversions	n	Return versioned files or no. Possible values are 'y' or 'n'.
sharingstatus	n	Return "is file shared or no". y or n.
options		Return options. Possible values for tags to return: all_tags, filterinfo, filelist, stats, spaceinfo, refreshresult, tagslist, tagcloud. Possible values for file fields to return: basic_fields, all_fields or any set of file fields. Values are separated by '\|' symbol, for example: filelist\|tagslist\|basic_fields or filelist\|tagslist\|fi_id\|fi_pid or fi_id\|fi_name . May contain option `comments`. If this option is present then each file will have field commented. If this field is 0 then file has no comments. If this field is 1 then a file has comments. May contain option `locked`. If this option is present then each file will have field locker. If locker field is 0 then file is not locked. If this field is not 0 then a file is locked by user with locker id. May contain option `folderencrypted`. If this option is present then each folder will have field encrypted. If this field is 0 then folder is not encrypted. If this field is 1 then a folder has encryption phrase. May contain option `folderlinks`. If this option is present then each folder will have field links. If this field is 0 then folder has no links. If this field is 1 then a folder has links. May contain option `content_detection`. If this option is present and account have Content Detection support then each file will have field Content Detection. If this field is 0 then file has not tagged as Content Detection. If this field is more than 0 then a file is tagged as Content Detection, a folder have Content Detection files inside. If options param is empty then all_tags\|all_fields is used.
returnversions	n	Return versioned files even if they do not match to search. y or n.
type	o	Set type of search: v - advanced search (fi_name param is used for search words), l - in file name, file metadata and content (wildcards for word(s) from fi_name param are used to search in file name, file metadata and content), n - in file name and content (wildcards for word(s) from fi_name param are used to search in file name and content), c - in file content (wildcards for word(s) from fi_name param are used to search in content), m - in file metadata (wildcards for word(s) from fi_name param are used to search in file metadata), e - file name exact phrase (fi_name param is used for search words), s - file name starts with (fi_name param is used for search words), d - file name ends with (fi_name param is used for search words), a - file name all words (fi_name param is used for search words), o - file name any word (fi_name param is used for search words), x - by file extension (fi_extension param is used for extensions to search), i - in issues (fi_name param is used for search words), h - in annotations (fi_name param is used for search words).
fromdate		Can be used with advanced search (type=v) only. Files with modification date from.
todate		Can be used with advanced search (type=v) only. Files with modification date to.
dateclause		Reserved, not used
metaclause		Can be used with advanced search (type=v) only. Metadata search condition, possible values are OR or AND
metadata		Can be used with advanced search (type=v) only. Metadata search in format: Metata_Name_ID,Type_of_serach,Metadata_Value,Next_Metadata_condition[SEPARATOR]. [SEPARATOR] is ";" Type_of_serach can be: x - exact match for text metatags, c - exact match for text metatags, e - equals match for date metatags, m - later than match for date metatags, l - earlier than match for date metatags.
textoption		Can be used with advanced search or search in annotations (type=v or type=h) only. Possible values (values could be separated by semicolon): x - file name or content match exact word or phrase from fi_name param, wh - file name or content match whole word(s) from fi_name param, bw - file name or content words begin with word(s) from fi_name param, ew - file name or content words ends with word(s) from fi_name param, wx - use wildcards for word(s) from fi_name param to search in file name or content. It is mandatory if you want to search in file name\content with value from fi_name.
issues		Can be used with advanced search or search in issues (type=v or type=i) only. This param contains issues IDs to search assigned to documents separated by comma.
contentoption		Can be used with advanced search or search in annotations (type=v or type=h) only. Possible values are defined in PII settings as ID of PII filter rule (values could be separated by semicolon).
customformid		ID of a custom search form returned by getCustomSearchForms in case if custom search form is used
customform		Data from custom search form. It must be JSON or KEY=VALUE format of values of a form data. Form field names are returned by getCustomSearchForms If customformformat is json than this value is like {"duration":"100-2000","resolution":"720x304"}, if customformformat is keyvalues than this value is like duration=100-2000\nresolution=720x304\n.. where \n is a line break symbol
customformformat		Custom form data format - `json` or `keyvalues`. Default is keyvalues. Defines how the form is encoded to decode on the server
customformclause		Can be AND or OR . Defines how custom form filter works together with al other filters. It can be AND condition or OR condition. Default is AND
customforminternalclause		Can be AND or OR. Defines how custom form fields works together is it logical AND or OR condition.

You must log in to be able to check this function execution.

Response:

doSearchPublicFiles - Searches the public files of all StorageMadeEasy users i.e. files they have designated public which reside on underlying clouds.

GET

Searches the public files of all StorageMadeEasy users i.e. files they have designated public which reside on underlying clouds.

Success response parameters:

The function returns the list of found public files.

Params

Name	Default	Description
search		search string
options		Options - list of chars that defines how to search. Possible values: n - search by file name, d - search by file description, t - search by tags, e - search by extension (extension must be exact like search string), p - search in extension (search string can be part of extension), a - search by any file data. Can be combined (like 'nd' means search by name or description)
type		'e' or 'a' or 'o'
returnlink	n	'y' or 'n'

You must log in to be able to check this function execution.

Response:

getCustomSearchForms - Returns list of all available custom search forms used for content search. For each form contains list of extensions where it can work. And list of fields.
Field types used in forms:
longinterval - must be a string in format N-M (N- or -M also works). M,N are long integers.
floatinterval - same as above but for float numbers
dropdown - text value should be selected from a dropdown. List of possible values must be present too. If options contain allowcustom it means a user can enter also a custom string

GET

getAvaliableFileTemplates - Get the list of available file templates. File templates are used for the creating of a new file. This function returns the list of all possible file types that can be created.

GET

createNewEmptyFile - Creates empty file by given extension. This enables the creation of MS Office type files that can be then edited directly, and saved, from the browser using the Zoho integration.

GET

Creates empty file by given extension. This enables the creation of MS Office type files that can be then edited directly, and saved, from the browser using the Zoho integration.

Success response parameters:

New file record.

Params

Name	Default	Value	Description
fi_name			file name
fi_extension			file extension
fi_pid			file parent folder id
contenttype			This is type of a file. Now this works only for htm files. If this value is link and next argument is URL then new created file will be bookmark with given link
content			This is URL in case if contenttype argument has value link and fi_extension argument has value htm

You must log in to be able to check this function execution.

Response:

doFavouriteFile - This Sets/unsets the favorite flag for files. You use this function to add file to favorites or remove a file from favorites.

GET

Name	Default	Value	Description
fi_id			file id
fi_favorite	1		file favorite state (1 or 0)

doFavouriteFolder - Makes folder favorite. This function is the same as doFavouriteFile but works for folders.

GET

getMyFavouriteFiles - Returns a list of favorite files for a user.

GET

Returns a list of favorite files for a user.

Success response parameters:

The list of files records.

Params

Name	Default	Description
showpath	n	Show path (y or n)
includefolders	n	Include folders info (y or n)
subfolders	n	Include subfolders info (y or n)
sharingstatus	n	Include sharing status (y or n)
commentedstatus	n	Include commenting status (y or n)
options		Return options. Values are separated by '\|' symbol, for example: locked\|folderlinks . May contain option `locked`. If this option is present then each file will have field locker. If locker field is 0 then file is not locked. If this field is not 0 then a file is locked by user with locker id. May contain option `content_detection`. If this option is present then each file will have field Content Detection. If this field is 0 then file has not tagged as Content Detection. If this field is more than 0 then a file is tagged as Content Detection. May contain option `folderlinks`. If this option is present then each folder will have field links. If this field is 0 then folder has no links. If 1 then a folder has links.
from	0	Number of the file from where to return results. 0 by default. It is used for paging of results
count	1000	Count of files to return. 1000 by default. Must be more 0 and not more 1000. It is used for paging of results

You must log in to be able to check this function execution.

Response:

doCopyFile - Copy file(s) from one folder to other. Response contains value `background`. If it is y then the operation will be done on background.

GET

Copy a file to another folder.

Success response parameters:

New created file

Params

Name	Default	Value	Description
fi_id			ID of file or list of IDs separated by comma
fi_pid			Folder ID. This is ID of a folder where to copy a file(s)
force			If force=y then file(s) will be copied without background task.
background			If background=y then will be created background task that will copy file(s) in background
fi_name			File name for a copy. Optional. If is not provided, a copy will have same name as a source file
options			Options (splitted with \| ). Supported options are: allownoextension .

You must log in to be able to check this function execution.

Response:

doUploadFromWeb - This function download file with given url and then upload the file to StorageMadeEasy account.

GET

This function download file with given url and then upload the file to StorageMadeEasy account.

Success response parameters:

Just status. File will be loaded in background. So this function just return message that new background task is added.

Params

Name	Default	Description
url		Direct URL to the file.
fi_pid		Folder ID. File will be uploaded to this folder
filename		File name, if empty then will be auto detected.
forcedownload	n	Force downloakd in the same request (not in background). Possible values are 'y' or 'n'.
comment		File comment.

You must log in to be able to check this function execution.

Response:

lockFile - The function locks file. It is not possible to edit the file while it is locked, but file can be downloaded.

GET

Name	Default	Description
fi_id		id of file or list of ids separated by comma
timeout	0	Time is seconds to lock the file.
options		Options (splitted with \| ). Supported options are: allowextend - if this file is locked by same user just extend expiration, disableextend - if this is present lock expiration renuval will not be used, .

unlockFile - The function unlocks the file.

GET

Name	Default	Value	Description
fi_id			id of file or list of ids separated by comma

getLockedFiles - Returns the list of all locked files for user.

GET

Returns the list of all locked files for user.

Success response parameters:

List of files

Params

Name	Default	Description
fullinfo	n	''y' or 'n'
fi_ids		comma separated list of files' ids
options		Options (splitted with \| ). Supported options are: sharingstatus, commentedstatus, .
from	0	Number of the file from where to return results. 0 by default. It is used for paging of results
count	1000	Count of files to return. 1000 by default. Must be more 0 and not more 1000. It is used for paging of results

You must log in to be able to check this function execution.

Response:

getFileVersions - Returns list of versions for file. Files can be versioned when upload to the same folder files with equal names. Older file will be renamed with timestamp.

GET

getVersionedFiles - Returns list of files that have 1 or more versions.

GET

deleteFileVersions - Deletes file versions. Can delete all versions or leave a specified count of files.

GET

getFileInfo - Returns information for the file.

GET

makeFrontVersion - This function promotes given file version to be main version. This function works only for versioned files. It replaces version of file with the file.

GET

requestFileApproval - Request a file for approval. It can be used when Approval functionality is enabled

GET

approveFile - Approve a file if it was previously requested ror approval. It can be used when Approval functionality is enabled

GET

getApprovers - Returns list of team members who are `approvers`. These are members who have a role where option `Can approve files` is allowed

GET

rejectFileApproval - Reject a file approval. Can be executed by an approver user and a file must be posted to approval before. It can be used when Approval functionality is enabled

GET

cancelFileApproval - Cancel a file approval request. Can be executed by a user who requested approval of this file. It can be used when Approval functionality is enabled

GET

getRestoreInfo - Return information about recovery options for a file. It has a list of items. Every item has 2 values: version and backup. Version is a reference to a version of a file, backup is a backup fil info. Some items can have both values, other items can have one of two values. Also, each item includes a type of a file: primarybackup, version, versionintrash, extrabackup

GET

doRestoreFile - Start a file recovery. Can recover a file from a version or from a backup.

GET

Start a file recovery. Can recover a file from a version or from a backup.

Params

Name	Default	Value	Description
fi_id			File ID
sourcetype			Type of a file recover source: remotefileid or versionid. In case of `remotefileid` the argument sourceid must be remote id of a backup file. In case of `versionid` the argument sourceid must be a file ID
sourceid			ID of a recovery source. Depends on an argument `sourcetype`
keeppreviousversion			Defines what to do with a previous version of a file. If this is `y` then a previous file will versioned. If `n` then previous version will be deleted

You must log in to be able to check this function execution.

Response:

doRestoreFolder - Start a folder recovery task. It creates acopy of a folder and each file is analised to chooose most correct version from all available.

GET

Start a folder recovery task. It creates acopy of a folder and each file is analised to chooose most correct version from all available.

Params

Name	Default	Value	Description
fi_id			Folder ID to recover
dest_fi_id			Destination folder ID. Copy of a recover folder will be created here.
restoretotime			Time to recover. File versions newer this time wll be ignored
preferbackup			y or n. If this is `y`, a backup copy of a file will be prefered , even if primary version has newer data (but less `restoretotime`)

You must log in to be able to check this function execution.

Response:

getFileTypeTools - Get available tools. May get file depending info.

GET

Get available tools. May get file depending info.

Params

Name	Default	Value	Description
fi_id			File ID
fi_code			Code of folder share URL.
password			Folder share URL (defined by fi_code) access password.
accesscode			Folder share URL (defined by fi_code) 2FA access code.
accessemail			Folder share URL (defined by fi_code) 2FA access email.

You must log in to be able to check this function execution.

Response:

Folder functions

doCreateNewFolder - Creates a folder within the StorageMadeEasy Cloud File System and also in the underlying cloud if the cloud provider supports this.

GET

Creates a folder within the StorageMadeEasy Cloud File System and also in the underlying cloud if the cloud provider supports this.

Success response parameters:

New folder info

Params

Name	Default	Description
fi_name		Name of the folder
fi_description		Description of the folder
fi_pid		ID of parent folder
fi_structtype		structure type code
fi_isorg	0	is team folder or not (1 or 0)
retifexst	n	this works only if the value is `y` . In this case if a folder with such name exists then it will be returned together with error message about a folder exists

You must log in to be able to check this function execution.

Response:

doRenameFolder - Renames a folder and allows you to change the description

GET

doDeleteFolder - Deletes a folder from StorageMadeEasy Cloud file system and the underlying cloud provider if the cloud provider supports this functionality.

GET

doMoveFolders - Move folder(s) to another folder.

GET

getFoldersList - Returns list of folders for account.

GET

resyncFolder - This function synchronize folder contents against mapped folder on provider side. The function adds new found files on provider side to StorageMadeEasy cache and remove files from StorageMadeEasy that doesn't exists on provider anymore. This operation is also called "folder refresh".

GET

This function synchronize folder contents against mapped folder on provider side. The function adds new found files on provider side to StorageMadeEasy cache and remove files from StorageMadeEasy that doesn't exists on provider anymore. This operation is also called “folder refresh”.

Success response parameters:

Returns couple of values with results of refresh. Cacheisactual – 'y' or 'n'. If 'y' then folder was not refreshed because folder's cache is in actual state (is fresh). Addedtobackground – if 'y' then refresh task is added to list of tasks for async refresh. In this case value 'backgroundtaskid' is ID of background task. Werechanges – if 'y' then something was changed during refresh newfiles, updatedfiles, deletedfiles – lists of modifications.

Params

Name	Default	Value	Description
fi_id			folder Id
refreshtype			refresh type
optional			''y' or 'n'

You must log in to be able to check this function execution.

Response:

getFolderCacheStatus - The function returns time when the folder was cached and status of the cache for the folder (expired or not). Also this function can check if cache was updated since given time (optional)

GET

DownloadZippedFolder - The function returns zip (tar,tar.gz) file with all files from the folder and subfolders. If the feature is not available for user it will return standard error response

GET

DownloadArchive - The function returns zip (tar, tar.gz) file with all files and folders listed in a request. Folders are returned with all contents of a folder and subfolders. If the feature is not available for user it will return standard error response

GET

setFolderQuota - This function set quota for the folder. When a quota is reached then user performing the action (upload, copy to the folder, etc.) is informed and person who set the quota is informed by email that the quota was reached.

GET

getFolderQuota - This function get quota of folder. When a quota is reached then user performing the action (upload, copy to the folder, etc.) is informed and person who set the quota is informed by email that the quota was reached.

GET

checkFolderQuotaReached - Check if folder quota reached. When a quota is reached then user performing the action (upload, copy to the folder, etc.) is informed and person who set the quota is informed by email that the quota was reached. Only Team Admin can use this function.

GET

removeFolderQuota - This function remove quota of folder. When a quota is reached then user performing the action (upload, copy to the folder, etc.) is informed and person who set the quota is informed by email that the quota was reached.

GET

getFolderQuotas - Get list of all folders that has quotas

GET

getFolderTotalSize - Get total size of all files and subfolders. Return "foldertotalsize" or "taskid" on success. If folder total size unknown then will be created background task that will calculate it and "taskid" will be returned else the "foldertotalsize" will be returned with folder total size in bytes.

GET

getFolderWatermarkStatus - The function to get folder watermarking for pdf status.

GET

setFolderWatermarkStatus - The function to set/unset folder watermarking for pdf status.

GET

getNominatedForWatermarkingFolders - The function to get list of folder with watermarking for pdf (for preview or shared links).

GET

Commenting files

addComment - Add new comment for a file or a folder.

GET

addFileComment - This is the aliace for the API addComment

GET

updateComment - Update comment for a file or a folder.

GET

updateFileComment - Aliace for the API updateComment

GET

removeComment - Remove file or folder comment.

GET

removeFileComment - Aliace for the API removeComment

GET

getComments - Get comments for a file or a folder.

GET

Get comments for file.

Success response parameters:

The list of comments.

Params

Name	Default	Value	Description
fi_id			file or folder ID
since			Return comments since date. Date format is YYYY-MM-DD HH:MM:SS.
from			Starts from. Integer value that says from what number to list items. If is not set than items are listed from first item
count			Count of items to return. If is set then list will be truncated to this count

You must log in to be able to check this function execution.

Response:

getFileComments - The aliace for the API getComments

GET

Get comments for file.

Success response parameters:

The list of comments.

Params

Name	Default	Value	Description
fi_id			file or folder ID
since			Return comments since date. Date format is YYYY-MM-DD HH:MM:SS.
from			Starts from. Integer value that says from what number to list items. If is not set than items are listed from first item
count			Count of items to return. If is set then list will be truncated to this count

You must log in to be able to check this function execution.

Response:

getCommentedFiles - Check what files from specified list of files have any comments.

GET

getCommentAttachFolder - Returns a folder ID where a comment attachments can be uploaded.

GET

attachFileToComment - Attach a file to a comment as attachment. A file had to be uploaded to the folder returned with the funcion getCommentAttachFolder.

GET

removeCommentAttachment - Removes a comment attachment.

GET

Cloud Group and Sharing functions

doSendEmail - Send email to a friend with the file download link.

GET

Send email to a friend with the file download link.

Params

Name	Default	Description
fi_id		fi_id
friend_email		Friends emails separated by comma
from_name		From name
text		Message
days	0	For how long files links will be actual.
emailtype		reserved.
password		The password to protect the file. If the file is accessed with generated link then it will be needed to enter this password to download the file
hours	0	Count of hours while a link is active.
minutes	0	Count of minutes while a link is active.
shorturl	y	y or n. If y then short url (tinyurl) will be generated together with the direct link to the file.
infoname		Name(s) separated by comma of person(s)\organization(s) for whom URL is created. It may be mandatory if that set by Team Administrator (sharedinfofields Team option).
infoemail		Email(s) separated by comma of person(s)\organization(s) for whom URL is created. It may be mandatory if that set by Team Administrator (sharedinfofields Team option).
inforeason		Purpose for which URL is created. It may be mandatory if that set by Team Administrator (sharedinfofields Team option).

You must log in to be able to check this function execution.

Response:

getGroupsList - Return all groups that has the current user as the member or just selected group information.

GET

getGroups - Return all groups where the current user is the member .

GET

Return all groups where the current user is the member .

Params

Name	Default	Description
filter		Filter by group name.
options		Options. Not yet used.
limit	0	Max count fo results
offset	0	Shift in results. Use this for pagination

You must log in to be able to check this function execution.

Response:

getGroupUsers - Return list of members for a group.

GET

Return list of members for a group.

Params

Name	Default	Description
gr_id		ID of the group
userids		Filter by user IDs. Comma separated list of users IDs
excluserids		Exclude filter by user IDs. To skip specified list of users from results. Comma separated list of IDs
filter		Filter by a user name.
options		Options. Not yet used.
limit	0	Max count fo results
offset	0	Shift in results. Use this for pagination

You must log in to be able to check this function execution.

Response:

getGroupInvitations - Return list of active invitations to a group.

GET

Return list of active invitations to a group.

Params

Name	Default	Description
gr_id		ID of the group
filter		Filter by an invitation email.
options		Options. Not yet used.
limit	0	Max count fo results
offset	0	Shift in results. Use this for pagination

You must log in to be able to check this function execution.

Response:

getAllShared - Returns the list of all shared files.

GET

getSharedByGroup - Returns the list of files shared for a specified group and user.

GET

Returns the list of files shared for a specified group and user.

Params

Name	Default	Description
gr_id	0	Id of group to return information. If is not set then information for all groups is returned.
us_id		User ID. If is not set then function will return files shared for group . If is set then files shared for this user in this group will be returned and also files shared by this user to current user.
fi_id		Folder ID. This is id of shared folder . This is used to get contents of shared folder.
fi_id2		Subfolder ID. This is id of subfolder of shared folder. This must not be direct subfolder. Can be few levels deep subfolder. (if this is 0 then just content of shared folder is shown)
fi_type		Type of items. If is not set then both files and folders are returned . If 1 then only subfolders are returned. If 0 then only files are returned
from		Starts from. Integer value that says from what number to list items. This can be used for limiting of count of returned items for folders with long files list. If is not set than items are listed from first item
count		Count of items to return. If is set then list will be truncated to this count
options		Return options. Could be separated by \|, possible options: nogroup => to return files related to userid only; grouponly => to return files related to group only; nobranch => to return files without branching and without tree; subfolders => to count of subfolders for shared folders folders; commentedstatus => return commented status for every file.
orderby		Field to order results. Allowed values are: fi_name, fi_extension, fi_type, fi_created,fi_size . Also every of allowed values can be used together with DESC suffix. Example, fi_name DESC - means sort by name in descending order.

You must log in to be able to check this function execution.

Response:

getFileURL - Generate direct link to file or folder. The link can be used to share the file or folder. If days and hours and minutes are 0 then the link time is unlimited.

GET

Generate direct link to file or folder. The link can be used to share the file or folder. If days and hours and minutes are 0 then the link time is unlimited.

Params

Name	Default	Description
fi_id		File or folder id.
days	0	Count of days while a link is active.
hours	0	Count of hours while a link is active.
minutes	0	Count of minutes while a link is active.
password		The password to protect the file. If the file is accessed with generated link then it will be needed to enter this password to download the file.
shorturl	n	y or n. If y then short url (tinyurl) will be generated together with the direct link to the file.
downloadlimit	0	Downloads number limit for a link. If 0 then unlimited.
options		File\Folder url generation options. Could be separated by \|, possible options are: withname => to return name of file; nolisting => make folder URL without listing of folder, can be used for users with appropriate package; canupload => make folder URL with possibility to upload files by anonymous users into this folder and sub-folders, can be used for users with appropriate package; editlink => that is file edit redirect link, can be used by logged in users from the same organization only; forcelogin => make link to be used by logged in users only; accesscode => ask access code (will be sent on email) before fileolder access; forcenotification => make URL to notify on every download by email; reuse => return existent link, works only for links witout expiration and password.
emailto		Email address or list of emails separated with comma, semicolon or space to send shared link to. Also can be contacts IDs, Organization user IDs, Organization external user IDs in format `contact:ID1,contact:ID2,user:ID3,euser:ID4,example@example.com...` where IDn is fi_id of a contact or us_id of Oreganization user\Organization external user.
emailfromname		Name of email sender. If is not set then current user name will be used. This will work only if `emailto` is set.
emailtext		Text in email message. This will work only if `emailto` is set.
saveemailincontacts	n	y or n. If this is `y` then email(s) from `emailto` argument will be saved to contacts (if is not yet in contacts). This will work only if `emailto` is set.
smsnumber		Phone numbers in international format separated by comma to send shared link password to. This will work only if `password` param is set and Twilio integration is set.
emailpassword	n	y or n. Email shared link password (as separated email). This will work only if `password` param is set.
copytome	n	y or n. If this is `y` then every shared link notification email will be copied (CC) to user who execute that API function.
infoname		Name(s) separated by comma of person(s)\organization(s) for whom URL is created. It may be mandatory if that set by Team Administrator (sharedinfofields Team option).
infoemail		Email(s) separated by comma of person(s)\organization(s) for whom URL is created. It may be mandatory if that set by Team Administrator (sharedinfofields Team option).
inforeason		Purpose for which URL is created. It may be mandatory if that set by Team Administrator (sharedinfofields Team option).
us_id		List of ids, comma separated. It can be list of users IDs or/and roles IDs. Every id should be set in format ID:TYPE, where type is `u` for user, and `r` for role. Example: 123:u,1234:r,12345:u

You must log in to be able to check this function execution.

Response:

getFileURLList - Get list of all generated URLs to file or folder.

GET

getSharedURLList - Get list of all generated URLs of users.

GET

Get list of all generated URLs of users.

Params

Name	Default	Description
us_id	0	User ID, could be 0 [if 0 then team admin user will get list of URLs of all organization users].
from	0	From.
count	0	Count items to return.
search		Search in url code
orderby		Field to order results. Allowed values are: id, days, login, infoname, inforeason. Also every of allowed values can be used together with DESC or ASC suffix. Example: id DESC - means sort by file id in descending order.

You must log in to be able to check this function execution.

Response:

getUserSharedURLList - Get list of all generated URLs forthe user.

GET

Get list of all generated URLs forthe user.

Params

Name	Default	Description
us_id	0	Limit returned results to URLs which were generated by specified User ID(s), could be empty or 0 to return all share URLs generated for the user.
from	0	From.
count	0	Count items to return. 20 items by default (if count equals to 0). Max 100 items.
search		Search in file or folder name
orderby		Field to order results. Allowed values are: fi_sharedid, us_login, fi_name, infoname, inforeason. Also every of allowed values can be used together with DESC or ASC suffix. Example: fi_sharedid DESC - means sort by URL id in descending order.

You must log in to be able to check this function execution.

Response:

updateFileURL - Update link to file info. If days and hours and minutes are 0 then the link time is unlimited.

GET

Update link to file info. If days and hours and minutes are 0 then the link time is unlimited.

Params

Name	Default	Description
fi_sharedid		Share URL id.
days	0	Count of days while a link is active.
hours	0	Count of hours while a link is active.
minutes	0	Count of minutes while a link is active.
password		The password to protect the file. If the file is accessed with generated link then it will be needed to enter this password to download the file
downloadlimit	0	Downloads number limit for a link. If 0 then unlimited.
options		File\Folder url generation options. Could be separated by \|, possible options are: editlink => that is file edit redirect link, can be used by logged in users from the same organization only; forcenotification => make URL to notify on every download by email; forcelogin => make link to be used by logged in users only; accesscode => ask access code (will be sent on email) before fileolder access; nolisting => make folder URL without listing of folder; canupload => make folder URL with possibility to upload files by anonymous users into this folder and sub-folders.
us_id		List of ids, comma separated. It can be list of users IDs or/and roles IDs. Every id should be set in format ID:TYPE, where type is `u` for user, and `r` for role. Example: 123:u,1234:r,12345:u

You must log in to be able to check this function execution.

Response:

deleteFileURL - Delete link to file.

GET

getSharedFolderContents - Return all files and sub-folders in a given shared folder with attributes.

GET

Return all files in a given folder with all attributes.

Success response parameters:

List of files. Also there is node 'refreshresult' that contains response of function resyncFolder. This node can be used to get information about folder cache state.

Params

Name	Default	Description
fi_code		Code of share url.
fi_pid	0	Sub-folder id inside shared folder, could be 0 if you want to browse shared folder.
password		Reserved. Not used yet.
from		Starts from. Integer value that says from what number to list items. This can be used for limiting of count of returned items for folders with long files list. If is not set than items are listed from first item
count		Count of items to return. If is set then list will be truncated to this count
orderby		Field to order results. Allowed values are: fi_name, fi_extension, fi_type, fi_created,fi_size. Also every of allowed values can be used together with DESC suffix. Example, fi_name DESC - means sort by name in descending order.
options		Possible value includeversions

You must log in to be able to check this function execution.

Response:

doCreateFolderInShared - Create folder inside shared drop folder.

GET

Create folder inside shared drop folder.

Params

Name	Default	Description
fi_code		Code of share url.
password		Dropfolder access password.
fi_name		New folder name.
fi_description	0	New folder description.
fi_pid	0	Folder parent id.

You must log in to be able to check this function execution.

Response:

getFileUrlAccessCode - Send file URL access code on email.

GET

getFileViewEditUrl - Get file edit or view url. You may use getFileTypeTools API call to find file related tools or available tools.

GET

Get file edit or view url. You may use getFileTypeTools API call to find file related tools or available tools.

Params

Name	Default	Value	Description
fi_id			File id.
tool			Viewer or editor tool. Viewers and editors are depending from file exstension and organization policy settings. You may use getFileTypeTools API call to find file related tools or available tools.
fi_code			Code of folder share url.
password			Folder share URL (defined by fi_code) access password.
accesscode			Folder share URL (defined by fi_code) 2FA access code.
accessemail			Folder share URL (defined by fi_code) 2FA access email.

You must log in to be able to check this function execution.

Response:

getSharedByUser - Returns all files shared by user for current user.

GET

Returns all files shared by user for current user.

Params

Name	Default	Description
us_id		User id
gr_id		Group Id
options		Options separated by "\|" symbol. Possible options are: subfolders, commentedstatus.
from	0	Return results from this position.
count	0	How many records to return.
orderby		Order column.

You must log in to be able to check this function execution.

Response:

doCreateGroup - Create new group.

GET

Create new group.

Params

Name	Default	Description
gr_title		gr_title
gr_description		gr_description
gr_permissions	0	gr_permissions
gr_private	n	Is group private ? Possible values are 'y' or 'n'. If 'y' then group members can not see who are group members. Group member can only see himself and creator. Group creator can see all members.
gr_modify	n	Allow to group members to modify files. Possible values are 'y' or 'n'.

You must log in to be able to check this function execution.

Response:

doRenameGroup - Update group info.

GET

Update group info.

Params

Name	Default	Description
gr_id		gr_id
gr_title		gr_title
gr_description		gr_description
gr_permissions	0	gr_permissions
gr_private	n	Is group private ? Possible values are 'y' or 'n'. If 'y' then group members can not see who are group members. Group member can only see himself and creator. Group creator can see all members.
returnalldata	n	return all data.
gr_modify	n	Allow to group members to modify files. Possible values are 'y' or 'n'.

You must log in to be able to check this function execution.

Response:

doDeleteGroup - Delete group. Only the group creator can delete it.

GET

doEditGroupUser - Edit group member permissions.

GET

doInviteToGroup - Send email to a friend / colleague with the link to become a member of a business group.

GET

Send email to a friend / colleague with the link to become a member of a business group.

Success response:

Just status and invitation code.

Params

Name	Default	Description
gr_id		Group ID
friend_email		Email of friend
from_name		From Name
text		Message text
emailtype		Possible values are: empty and "contacts". If it is "contacts" then friend_email must be ID of file and the invite will be sent to the owner of this file.
us_permissions	0	Permissions. Possible values are 0, 1 or 2. 0 - Inherit from group 1 - Can share files 2 - Can not share files
notify	y	Notify user by email on invitation or no. This option can be used to control invited user notification. Possible values are: y or n. Note: user will be notified by email only if other options allow to do that.

You must log in to be able to check this function execution.

Response:

doRepeatInvitation - Repeat email to friend with link to become a member of a business group.

GET

doAcceptInvitation - Accept or refuse invitation to the business group.

GET

doDeleteInvitation - Delete invitation.

GET

doShareFileWithGroup - Share the file with the group or the user.

GET

Share the file with the group or the user. If user id is 0 then file are shared with all members of the group otherwise only with specified user. If count of days is 0 or empty then sharing is unlimited in time. If the count is specified then this is the number of days that the link will be active before expiring.

Success response:

Shared file record.

Params

Name	Default	Description
gr_id		Group ID
fi_id		File id or comma separated ids
gr_expired	0	Count of days. If count of days is 0 or empty then sharing is unlimited in time. If the count is specified then this is the number of days that the link will be active before expiring.
gr_comment		Comment
us_id		User Id. If user id is 0 then file are shared with all members of the group otherwise only with specified user.
addrule	n	Add rule."y" or "n".
rl_rule		The text that file name (or another info) must contain to be shared.
rl_type		The list of file attributes that must contain rule text. Allowed: fi_name - file name, fi_extension - file extension, fi_description - description. Example: fi_name,fi_extension,fi_description . Example 2: fi_name
rl_folder		Folder id where rule works. If 0 then root folder.
rl_subfolders		Include subfolders - y or n. If y then rule works also in subfolders of rule folder.
sharewithsubfolders	"y" or "n".
options	Options seperated by "\|". Possible values: copyprivateannotations, statusonly, nobranch

You must log in to be able to check this function execution.

Response:

doShareFolderWithGroup - Share the folder with the business group or the user.

GET

Share the folder with the business group or the user.

Success response parameters:

Shared folder record with all files and subfolders (if subfolders are shared).

Params

Name	Default	Description
gr_id		Group ID.
fi_id		Folder ID.
gr_expired	0	Count of days. If count of days is 0 or empty then sharing is unlimited in time. If the count is specified then this is the number of days that the link will be active before expiring.
gr_comment		Comment.
us_id		User Id. If user id is 0 then file are shared with all members of the group otherwise only with specified user.
addrule	n	Add a new rule for autosharing: y or n.
rl_rule		The text that file name (or another info) must contain to be shared.
rl_type		The list of file attributes that must contain rule text. Allowed: fi_name - file name, fi_extension - file extension, fi_description - description. Example: fi_name,fi_extension,fi_description . Example 2: fi_name
rl_folder		Folder id where rule works. If 0 then root folder.
rl_subfolders		Include subfolders - y or n. If y then rule works also in subfolders of rule folder.
sharewithsunfolders	n	Check if to share subfolders (y or n). If y then subfolders are shared too.
options		Return options. Possible values for tags to return: statusonly. If options param is statusonly then will be returned status without shared tree.

You must log in to be able to check this function execution.

Response:

getFileSharingStatus - Get the list of groups and users that the file/folder is shared for.

GET

getSharingStatus - This is alias for function getFileSharingStatus.

GET

doDeleteShared - Delete shared file from shared files list.

GET

doUnsubscribeGroup - Unsubscribe user from the business group.

GET

doRequestFile - Request file from a business group user. The user receives an email in which he is requested to share a file with the business group.

GET

doPublicFile - Set or unset a file as public. A public file can be viewed by anyone on the Internet.

GET

getPublicFiles - Searches public files.

GET

getAutoshareRules - Returns a list of autosharing rules. Auto-sharing rules are information about a file, folder, file extension or whole file-tree that outline what watches should be set.

GET

doAddAutoShareRule - Add a new rule for autosharing.

GET

Add a new rule for autosharing.

Success response parameters:

New rule info.

Params

Name	Default	Value	Description
gr_id			Group ID to autoshare file for.
us_id			User ID to autoshare file for. If 0 then for all group members.
rl_rule			The text that file name (or another info) must contain to be shared.
rl_type			The list of file attributes that must contain rule text. Allowed: fi_name - file name, fi_extension - file extension, fi_description - description. Example: fi_name,fi_extension,fi_description . Example 2: fi_name
rl_folder			Folder id where rule works. If 0 then root folder.
rl_subfolders			Include subfolders - y or n. If y then rule works also in subfolders of rule folder.

You must log in to be able to check this function execution.

Response:

doDeleteAutoShareRule - Deletes autoshare rule. Auto-sharing rules are information about a file, folder, file extension or whole file-tree that outline what watches should be set.

GET

Email backup functions

getEmailAccounts - Returns the list of all email accounts for a user.

GET

doCheckEmailAccountSettings - Check email account settings. This function is used to check if user entered valid IMAP data before adding a new email account.

GET

Check email account settings. This function is used to check if user entered valid IMAP data before adding a new email account.

Success response parameters:

Return item 'connected' indicates if connection were established. If is 0 then it was not established. In this case item 'errormessage' contains the error message.

Params

Name	Default	Value	Description
em_host			IMAP host of the account
em_username			account IMAP username
em_password			account IMAP password
em_port			account IMAP port
em_tsl			'y' or 'n'. If connection is sequre

You must log in to be able to check this function execution.

Response:

doCreateEmailAccount - Create a new email account

GET

Create a new email account

Success response parameters:

New account info

Params

Name	Default	Value	Description
em_name			account name
em_host			account IMAP host
em_username			account IMAP username
em_password			account IMAP password
em_port			account IMAP port
em_tsl			sequre connection ('y' or 'n')

You must log in to be able to check this function execution.

Response:

doEditEmailAccount - Email account information

GET

Email account information

Success response parameters:

Updated account info

Params

Name	Default	Value	Description
em_id			account id
em_name			account name
em_host			account IMAP host
em_username			account IMAP username
em_password			account IMAP password
em_port			account IMA port
em_tsl			sequre connection ('y' or 'n')

You must log in to be able to check this function execution.

Response:

doDeleteEmailAccount - Delete email account.

GET

doBackupEmailBoxInBackground - Add email box backup task to background tasks. Status of the backup can be obtained with the background tasks functions.

GET

getEmailAccountFolders - Return IMAP folders for an email account. olders returned with this function are used when calling the function doBackupEmailBoxInBackground to define what IMAP folders will be backed up.

GET

Encryption functions

doCheckEncryptionPhrase - Checks if the encryption phrase is correct for the file.

GET

setFolderEncryptStatus - The function to set\unset folder files encryption.

GET

getFolderEncryptStatus - The function to get folder encryption status.

GET

getNominatedForEncryptionFolders - The function to get list of folders nominated for encryption.

GET

Fax functions

doFaxDocuments - Fax documents. Note that an Interfax account is needed for Faxing.

GET

getFaxesList - Get list of documents that are in temporary list prepared for faxing. Note an Interfax account is needed for faxing.

GET

doAddToMyFaxes - Add (delete) document(s) to (from) temporary list of documents for faxing. Note an Interfax account is needed for faxing.

GET

Filter functions

getFilesFilter - Returns filter if it was set by user

GET

doSetFilesFilter - Set/update files filter.

GET

Set/update files filter.

Success response parameters:

The function returns new filter info.

Params

Name	Default	Value	Description
fl_target			filter target (d or f)
fl_type			filter type (a,s,or n)
fl_data			filter data
fl_structtype			structure type codes, comma splitted. Ex. g,e . If empty then filer works for all structures

You must log in to be able to check this function execution.

Response:

doDeleteFilesFilter - Deletes files filter if it was set by user

GET

doSuggestTags - Return list of tags that starts with specified string. Can be used for adding of new tags

GET

Trash functions

getFolderContentsFromTrash - Return files and sub-folders in a given folder with all attributes.

GET

Return files and sub-folders in a given folder with all attributes.

Success response parameters:

List of files.

Params

Name	Default	Description
fi_id	0	ID of folder
from		Starts from. Integer value that says from what number to list items. This can be used for limiting of count of returned items for folders with long files list. If is not set than items are listed from first item
count		Count of items to return. If is set then list will be truncated to this count
fi_type		Type of items. If is not set then both files and folders are returned. If 1 then only subfolders are returned. If 0 then only files are returned
orderby		Field to order results. Allowed values are: fi_name, fi_extension, fi_type, fi_created, fi_size. Also every of allowed values can be used together with DESC suffix. Example, fi_name DESC - means sort by name in descending order. If you don't want to sort result then use value: nothing
subfolders	n	Show count of subfolders. 'y' or 'n'. If is 'y' then for every subfolder count of subitems will be returned. This can be used for knowing of subfolder has something (files/folders) or not
options		Return options. Possible values for tags to return: all_tags, filelist, folder, parents, refreshresult, curfolder. Possible values for file fields to return: basic_fields, all_fields or any set of file fields. Values are separated by '\|' symbol, for example: folder\|parents\|basic_fields or fi_id\|fi_pid. May contain option `comments`. If this option is present then each file will have field commented. If this field is 0 then file has no comments. If 1 then a file has comments. May contain option `folderlinks`. If this option is present then each folder will have field links. If this field is 0 then folder has no links. If 1 then a folder has links. If options param is empty then all_tags\|all_fields is used.

You must log in to be able to check this function execution.

Response:

doDeleteFromTrash - Deletes specified files/folders from trash. If file ID is 0 then all trash content is deleted (emptying the trash)

GET

doRestoreFromTrash - Restores specified files/folders from trash. If files/folders are not specified then all trash content is restored and trash cleared

GET

emptyTrashInBackground - Remove all files from Trash with background processing. If this function is called then a new background task is created.

GET

Provider functions

getProviders - Returns the list of allowed cloud storage providers types for the users package. Also returns the list of already used provider accounts. Provider types are S3, Mosso (RackSpace), Box.Net, FTP, Gmail, Email, WebDav, SkyDrive, MobileMe. This list can be extended in the future. Some packages have only 1 provider type allowed. Some have more.

GET

getProvidersForOrgMember - This function can be called by Team Admin to return providers of Team member (private and Team providers).

GET

doProviderSyncInBackground - Synchronise files in cloud provider account and StorageMadeEasy DB in background. This is alternative for function doProviderSync. Once doProviderSyncInBackground is called sync starts on background.

GET

Synchronise files in cloud provider account and StorageMadeEasy DB in background. This is alternative for function doProviderSync. Once doProviderSyncInBackground is called sync starts on background.

Success response parameters:

Returns success or not.

Params

Name	Default	Description
pi_id		id of provider to sync
reserver		leave empty, the argument is not used anymore
fi_id	0	Folder ID. Set this argument value if resync should work for a specific fodler only and subfolders, but not full cloud
options		Request options. Supported opptions: initial - force to run initial sync if this cloud was not yet synced. It is used when a cloud was added without autosync requested and this cloud was never synced yet. Initial sync works faster than resync, so it can be used as an option

You must log in to be able to check this function execution.

Response:

getResyncReports - Get reports about provider sync.

GET

Get reports about provider sync.

Params

Name	Default	Description
pi_id		Id of provider to filter report for
fi_id	0	Folder ID. List reports which were done for a specific fodler only and subfolders, but not full cloud
limit	100	Return only last reports, limited by this value. In combination with offset allows to make the reports paging
offset	0	Paging offset.
options		\| separated list of options. At this time only 2 options can be used and nottogether. `cloud` returns only reports for full cloud resync/init sync. `folders` - returns only reports for separate folders syncs

You must log in to be able to check this function execution.

Response:

getResyncReport - Get provider sync report log records.

GET

Get provider sync report log records.

Params

Name	Default	Description
rep_id		Report id
offset	0	Offset
limit		Limit log records. This value is limited to 500. 500 is used if param is empty or omitted.
type		Filter log records by specified type.
group		Filter log records by specified group.
cloudtype		Filter log records by specified cloud type.

You must log in to be able to check this function execution.

Response:

syncOnProviderEvent - Is called when single file must be synced with Nasuni Access Anywhere Server. This API should be used when new file appears on a cloud or is updated or deleted. And it is needed to notify Nasuni Access Anywhere Server about this file action. This API works also for folders.

GET

Is called when single file must be synced with Nasuni Access Anywhere Server. This API should be used when new file appears on a cloud or is updated or deleted. And it is needed to notify Nasuni Access Anywhere Server about this file action. This API works also for folders.

Params

Name	Default	Value	Description
pi_id			id of provider to sync file
remoteid			ID of a file or folder on cloud. For many clouds this is a file/folder path. For Object Storage clouds this is in format `bucket::path/to/file.doc` or `bucket::path/to/folder/`. Folder path always must end with `/` symbol, it is a marker of a folder. For FTP, Dropbox, WebDAV it is just file/folder path (for folders ending with `/` as well). For Google Drive or Box.net it is ID of a file/folder on a cloud
event			Object event type. Can be `create`, `delete`, `update`, `createorupdate`. It can be also empty. IN this case an event type will be detected automatically.

You must log in to be able to check this function execution.

Response:

checkProviderObjectState - Checks if a file/folder from a cloud exists in Nasuni Access Anywhere Server.

GET

doRemoveProvider - Removes provider from StorageMadeEasy. All files are removed from StorageMadeEasy DB. But files are not removed from their storage location and can be accessed without StorageMadeEasy.

GET

getAddProviderMetaFields - Returns the list of data fields that must be provided to create new provider of given type. Usually these are 2 fields - login and password. For some provider types it is needed to provider more fields (like for Email or FTP). This function returns list of fields, titles and descriptions. Also this function returns status of oAuth support and options of oAuth authentification if it is supported. This function is called before the creation of a new provider.

GET

doAddProvider - Adds new provider. This iss called a few times (steps). 0 step - provide provider access data; 1 step - select buckets (only for S3, RackSpace,Google Storage, Windows Azure); 2 step - chose if to save provider info (only for packages where 1 provider allowed); 3 step - do final saving of provider. NOTE: bucket means bucket in Amazon S3 and Google Storage service. I case of RackSpace bucket means container.

GET

Adds new provider. This iss called a few times (steps). 0 step – provide provider access data; 1 step – select buckets (only for S3, RackSpace,Google Storage, Windows Azure); 2 step – chose if to save provider info (only for packages where 1 provider allowed); 3 step – do final saving of provider. NOTE: bucket means bucket in Amazon S3 and Google Storage service. I case of RackSpace bucket means container.

Success response parameters:

For all steps function returns next step number (whatnextcode item). And next step description. Another returned data are related to step. For step 0: Success or not. If provider type is S3 or Mosso then also buckets list will be returned. It is used for step 1. For step 1 and 2: Just success or not. For step 3: Created provider info.

Params

Name	Default	Value	Description
pr_id			provider type ID
step			step number
data			Only for the step 0. Is mandatory in case if oauthtoken is missed. Special formatted string with provider access info (see below about format)
isbackupfor			Only for the step 0. If this provider is backup then this value is ID of existent provider
oauthtoken			Only for the step 0. The oauthtoken to access the provider. Is used only for providers with oauth support
providertitle			Only for the step 0. The title os the provider
defaultbucket			Only for the step 1. default bucket name. Can be missed if createnew argument is present
buckets			Only for the step 1. the list of buckets. Comma seperated
createnew			Only for the step 1. new bucket name. Used only in case if new bucket must be added. This bucket is set as default after creation
nboptions			Only for the step 1. option for creating of new bucket if 'createnew' argument is not empty
savemyinfo			y or n. If to save provider info

You must log in to be able to check this function execution.

Response:

doQuickAddProvider - This function is similar to doAddProvider but is executed only 1 time to add a provider faster. If this function is used for a provider that uses buckets/containers (ex. Amazon S3 or RackSpace) then it is needed to post the buckets list as argument for this function. Before calling this function it is needed to call function getBucketsByAccessData to get list of all buckets for a provider. To know if provider uses buckets analyse response of the function getAddProviderMetaFields. This function is used to get the list of auth fields for provider. Also it returns value usesbuckets . If this value is 'y' then provider uses buckets.

GET

This function is similar to doAddProvider but is executed only 1 time to add a provider faster. If this function is used for a provider that uses buckets/containers (ex. Amazon S3 or RackSpace) then it is needed to post the buckets list as argument for this function. Before calling this function it is needed to call function getBucketsByAccessData to get list of all buckets for a provider. To know if provider uses buckets analyse response of the function getAddProviderMetaFields. This function is used to get the list of auth fields for provider. Also it returns value usesbuckets. If this value is 'y' then provider uses buckets.

Success response parameters:

Created provider info. NOTE: bucket means bucket in Amazon S3 service. In the case of RackSpace bucket means container.

Params

Name	Default	Value	Description
pr_id			id of provider type
accessdata			provider access data in format the same as doAddProvider has
savemyinfo			'y' if provider login/password should be saved on StorageMadeEasy server. 'n' - if do not save and user want to enter this data all time
defaultbucket			bucket that should be default for provider (if provider doesn't support buckets then just set this t empty string)
buckets			list of buckets. the same format as doAddProvider has
createnew			if is 'y' then new bucket with name in defaultbucket argument will be created
bucketoptions			buckets oprions. currently there is only 1 option only for Amazon S3. Option is bucketlocation . can have values from list US, EU, us-west-1, ap-southeast-1 . Format is bucketlocation=VAL. If is missed then bucketlocation=US
isbackupfor			ID of existent provider if this is backup
pi_private			'y' or 'n' (optional)

You must log in to be able to check this function execution.

Response:

getBucketsByAccessData - This function is used to get list of buckets (containers) for provider account before add new provider with function doQuickAddProvider . This function is called for providers of type 2 (Amazon S3, RackSpace Cloud, Google Storage, Windows Azure Blob).

GET

doSetDefaultProvider - Set provider to be the default

GET

doSetMasterCopy - Set or unset provider as the golden copy of data that will be used for sync with a provider.

GET

getProviderBuckets - List provider buckets. This is used only for S3 or Mosso (RackSpace). For Mosso (RackSpace) bucket means container.

GET

doUpdateBucketsList - Updates the list of buckets that is used in the StorageMadeEasy. This is used only for S3 or Mosso (RackSpace). For Mosso (RacksSpace) bucket means container.

GET

Updates the list of buckets that is used in the StorageMadeEasy. This is used only for S3 or Mosso (RackSpace). For Mosso (RacksSpace) bucket means container.

options param format:
bucketname1=option1=val1,option2=val2\n
bucketname2=option1=val3,option2=val3\n

Success response parameters:

Function returns the list of provider buckets that are used in StorageMadeEasy. Default bucket is not included in this list.

Params

Name	Default	Value	Description
pi_id			provider ID
buckets			Comma separated list of buckets, if backet contain code then you may encode it in csv format.
options			backets options separated by new line

You must log in to be able to check this function execution.

Response:

doSetDefaultBucket - Sets default bucket. Default bucket is used when it is not specified where to upload file. This is used only for S3 or Mosso (RackSpace). For Mosso (RackSpace) bucket means container.

GET

doAddBucket - Adds new bucket. Bucket is created in S3 (or container in Mosso). And just created bucket is added to the list of used buckets. This is used only for S3 or Mosso. For Mosso bucket means container.

GET

doChangeProviderPassword - Changes provider account password that is saved in StorageMadeEasy. This function is used when account password was changed on cloud storage. Example, Gmail account password was changed. And it is needed to change it in StorageMadeEasy to continue working with the Gmail provider. Password can be API key. It is related to provider.

GET

Name	Default	Value	Description
us_name			us_name
us_address			us_address
us_phone			us_phone

Name	Default	Value	Description
fi_id			file ID
countleft	0		Number of last versions to leave. If is 0 os missed then all versions are deleted

Name	Default	Value	Description
fi_id			File ID
makereplace	n		Replace selected version with main version id. Possible values are: `y` or `n`.

Name	Default	Value	Description
fi_id			File ID
approver_us_id			Approver user ID. This is one of ID of a user received from the API function getApprovers
comment			A comment from requester to approver

Name	Default	Value	Description
fi_id			ID of the folder
fi_name			Name of the folder
fi_description			Description of the folder

Name	Default	Value	Description
fi_id			folder Id
lastchecktime			(optional) last check time

Name	Default	Value	Description
ids			Comma separated list of IDs - files or folders
format	zip		Format of the archive. Accepts values: zip, tar, targz. Default format is zip

Name	Default	Value	Description
fi_id			ID of folder
fi_quota			quota for folder in bytes. If is 0 then existing quota will be removed.

Name	Default	Value	Description
fi_id			ID of folder
size	0		Size in bytes that you want to add to the folder. Use this param when you want to check if there is enough space to upload/copy file to the folder.

Name	Default	Description
fi_id		folder Id
preview	n	Watermark pdf files during preview status (y - yes, n - no).
share	n	Watermark pdf files during download from shared link status (y - yes, n - no).

Name	Default	Value	Description
from	0		return result skipping previous items
count	25		count items to return (max - 100 items per request)

Name	Default	Value	Description
onlyids			'y' or 'n' - defines if to return full files info for commented files or just Ids
fi_ids			comma separated list of file IDs. The list of files to find among them what files are commented.

Name	Default	Value	Description
fi_id			Commented file ID. If this argument is not set then the next argument is mandatory. One of 2 arguments is required
fc_id			Comment ID. This argument is required only if the first is not set

Name	Default	Value	Description
us_id			ID of the user to request file
gr_id			ID of the group in witch file is requested
comment			Comment

Name	Default	Value	Description
user			username or '*'
tag			tag or '*'
order			'last' or 'popular'
limit			count of files to find

Name	Default	Value	Description
em_id			account id
folders			List of IMAP folders to backup comma separated. This are folders returned by the function getEmailAccountFolders.

Name	Default	Value	Description
fi_id			Folder Id
encstatus			Encryption status (y - yes, n - no).

Name	Default	Value	Description
fi_id			File id or comma separated ids
recipients			Return separated list of recipients
faxheader			Fax header

Name	Default	Value	Description
fi_id			File id or comma separated ids
delete			If y then files will be deleted from list. If any another value then files will be added

Name	Default	Value	Description
pi_id			id of provider to sync folder
remoteid			ID of a file or folder on cloud. For many clouds this is a file/folder path. For Object Storage clouds this is in format `bucket::path/to/file.doc` or `bucket::path/to/folder/`. For FTP, Dropbox, WebDAV it is just file/folder path (for folders ending with /). For Google Drive or Box.net it is ID of a file/folder on a cloud

Name	Default	Value	Description
pr_id			provider type ID
showhidden			y or n. Show hidden fields or no.

Name	Default	Value	Description
pi_id			provider ID
master			y or n. If provider should be master or not

Name	Default	Value	Description
pi_id			provider ID
bucket			bucket name
extra			extra information