Version no : 0.9.5.2
Last Update 2018-11-26
In order to receive an access_token, you must do the following:
Header Name | Description | Type |
ResellerTokenrequired | The Reseller Token | string |
ClientIDrequired | The client ID provided. | string |
ClientSecretrequired | The client secret provided. | string |
Actionrequired | The action name "ListDevices" | string |
Headers | Info | ||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||
ErrorMessage |
|
Parameter Name | Description | Type |
GUID | Shows the device GUID. | bool |
DeviceName | Shows the Device name. | int |
HotCapacity | Shows the device hot capacity in bytes. In case the value is -1 that means that there is no limit. | long |
ColdCapacity | Shows the device cold capacity in bytes. In case the value is -1 that means that there is no limit. | long |
UsedSpace | Shows the device hot storage used Space on bytes. | long |
ColdUsedSpace | Shows the device cold storage used Space in bytes. | long |
Status | Shows the status of the device ( Active = 0 , Suspend =1, Archive =2, PendingActivate =3) | int |
CreateDate | Shows the file creation date. (FileTime UTC) | long |
LastActivityDate | Shows the last activity date.(FileTime UTC) | long |
NickName | Shows the nickname of the device (Base64). | string |
DeviceType | Shows the device main type ( PC = 0 , Vault = 1 , Mobile = 2 ). | int |
DeviceSubType | Shows the device sub type ( Desktop = 0 , Laptop = 1, Vault = 2, Android = 4, IPhone = 5 ) | int |
OCRLimit | Shows the Device OCR limit. In case the value is -1 that means that there is no limit. | int |
UsedOCR | Shows the number of used OCR. | int |
IsCustomDevice | Show if the Device is created by the public APIs or not. | bool |
Parameter Name | Description | Type | Values | ||||||||||
ResellerTokenrequired | The Reseller Token | string | |||||||||||
ClientIDrequired | The client ID Provided. | string | |||||||||||
ClientSecretrequired | The client secret provided. | string | |||||||||||
Actionrequired | The action name"CreateDevice" | string | |||||||||||
DeviceNamerequired | The Device Name (Base64). | string | |||||||||||
NickNameoptional | The Device NickName (Base64). | string | |||||||||||
HotCapacityoptional | Set the hot storage capacity in giga bytes. default is no limit. The value -1 is no limit. | int | |||||||||||
ColdCapacityoptional | Set the cold storage capacity in giga bytes. default is no limit. The value -1 is no limit. | int | |||||||||||
OCRLimitoptional | Set the device OCR limit. default is no limit. The value -1 is no limit. | int | |||||||||||
DeviceTyperequired | Set the device Type. | int |
|
||||||||||
DeviceSubTyperequired | Set the device syb Type. | int |
|
Headers | Info | ||||||||||||||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
Parameter Name | Description | Type |
Guid | Shows the device GUID. | bool |
DeviceName | Shows the Device name. | int |
NickName | Shows the nickname of the device (Base64). | string |
HotCapacity | Shows the device hot capacity in bytes. In case the value is -1 that means that there is no limit. | long |
ColdCapacity | Shows the device cold capacity in bytes. In case the value is -1 that means that there is no limit. | long |
Status | Shows the status of the device ( Active = 0 , Suspend =1, Archive =2, PendingActivate =3) | int |
CreateDate | Shows the file creation date. (FileTime UTC) | long |
DeviceType | Shows the device main type ( PC = 0 , Vault = 1 , Mobile = 2 ). | int |
DeviceSubType | Shows the device sub type ( Desktop = 0 , Laptop = 1, Vault = 2, Android = 4, IPhone = 5 ) | int |
OCRLimit | Shows the Device OCR limit. In case the value is -1 that means that there is no limit. | int |
IsCustomDevice | Show if the Device is created by the public APIs or not. | bool |
Header Name | Description | Type |
ResellerTokenrequired | The Reseller Token | string |
ClientIDrequired | The client ID Provided. | string |
ClientSecretrequired | The client secret provided. | string |
Actionrequired | The action name "DeleteDevice" | string |
DeviceGUIDrequired | The required Device GUID to be deleted | string |
Headers | Info | ||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||
ErrorMessage |
|
Header Name | Description | Type |
ResellerTokenrequired | The Reseller Token | string |
ClientID required | The client ID provided. | string |
ClientSecretrequired | The client secret provided. | string |
Actionrequired | The action name "SearchFiles" | string |
DeviceGUIDoptional | The GUID of the required device to make search on, default is null and the search will be done on all the devices on the user account. | string |
PageIndexrequired | The page index | int |
PageLimitrequired | Files in each page limit (max number is 50) | int |
Parameter Name | Description | Type | Values | ||||||||||||||||||||||||||||||||
SearchQuery optional | search query of what the user wants. | string | To get all files send the value of the SearchQuery as empty. | ||||||||||||||||||||||||||||||||
SearchFields optional | you can specify what the user want to search
Send the Value. |
int |
|
||||||||||||||||||||||||||||||||
TypeFilter optional | filter the type of files to search in.
Send the Value. |
int |
|
||||||||||||||||||||||||||||||||
SizeFilter optional | This filter is used for if the user want to filter his result using Size.
if the user sent the value as "Custom"
then these filters must be sent : CustomSizeFrom , CustomSizeTo
for sizeFilter
Send the Value. |
int |
|
||||||||||||||||||||||||||||||||
CustomSizeFrom optional | This needs to be sent if user choose a custom size filter and it must be in bytes. | long | |||||||||||||||||||||||||||||||||
CustomSizeTo optional | This needs to be sent if SizeFilter is set to custom and it must be in bytes. | long | |||||||||||||||||||||||||||||||||
DateModifyFilter optional | This filter is used for if the user want to filter his result using Date Modify, in this filter if send it as Custom
you must send the CustomDateModifyFrom and CustomDateModifyTo ..
for DateModifyFilter
Send the Value. |
int |
|
||||||||||||||||||||||||||||||||
CustomDateModifyFrom optional | This needs to be sent if DateModifyFilter is set to custom and it must be in long “FileTime” | string | |||||||||||||||||||||||||||||||||
CustomDateModifyTo optional | This needs to be sent if DateModifyFilter is set to custom and it must be in long “FileTime” | string | |||||||||||||||||||||||||||||||||
DocumentTypeFilter optional | This filter used when TypeFilter value is document .
choose the document type ..
Send the Value |
int |
|
||||||||||||||||||||||||||||||||
OCRTypeFilter optional | This filter used when TypeFilter value is ocr.
then choose the ocr type .. Send the Value |
string |
|
||||||||||||||||||||||||||||||||
OtherExtentionFilter optional | This filter used if TypeFilter is set to other and the value will be string for the specific extension that the user choose. | string | |||||||||||||||||||||||||||||||||
OtherExcludeExtentions optional | This will be sent only TypeFilter is set to other. | string | |||||||||||||||||||||||||||||||||
AudioExtentionFilter optional | This filter used when TypeFilter value is audio. choose the Extension Filter and the value will be string for the specific extension that the user choose. if the value is “other” in the AudioExtentionFilter. | string | |||||||||||||||||||||||||||||||||
AudioExcludeExtentions optional | This will be sent only if TypeFilter value is “audio”. | string | |||||||||||||||||||||||||||||||||
AudioDurationFilter optional | This filter used when TypeFilter value is audio.
choose Duration Filter, in this filter If you send “Custom” then you will need to send CustomAudioFrom And CustomAudioTo. for AudioDurationFilter .. send the Value |
int |
|
||||||||||||||||||||||||||||||||
CustomAudioFrom optional | This needs to be sent if AudioDurationFilter is set to custom | long | |||||||||||||||||||||||||||||||||
CustomAudioTo optional | This needs to be sent if AudioDurationFilter is set to custom. | long | |||||||||||||||||||||||||||||||||
VideoExtentionFilter optional | This filter used when TypeFilter is set to video.
choose the Extension Filter and the value will be string for the specific extension that the user choose. if “other” is the value of VideoExtentionFilter the you need to Send VideoExcludeExtentions filter values. |
string | |||||||||||||||||||||||||||||||||
VideoExcludeExtentions optional | This will be sent only if TypeFilter is set to video. the values will be the extensions that we return to you from the aggregations. | string | |||||||||||||||||||||||||||||||||
VideoDurationFilter optional | This filter used when TypeFilter is set to video.
In this filter if send "custom" then you will need to send CustomVideoFrom filter and CustomVideoTo. for VideoDurationFilter .. Send the Value |
int |
|
||||||||||||||||||||||||||||||||
CustomVideoFromoptional | This needs to be sent if VideoDurationFilter is set to custom. | long | |||||||||||||||||||||||||||||||||
CustomVideoTo optional | This needs to be sent if VideoDurationFilter is set to custom. | long | |||||||||||||||||||||||||||||||||
VideoDimensionFilter optional | This filter used when TypeFilter value is video.
If you send “Custom” then you will need to send CustomVideoWidth filter and CustomVideoTo filter. for VideoDimensionFilter .. Send the Value |
int |
|
||||||||||||||||||||||||||||||||
CustomVideoWidth optional | This needs to be sent if VideoDimensionFilter is set to custom. | long | |||||||||||||||||||||||||||||||||
CustomVideoHeight optional | This needs to be sent if VideoDimensionFilter is set to custom. | long | |||||||||||||||||||||||||||||||||
PicExtentionFilter optional | This filter used when TypeFilter value is photo. the value will be string for the specific extension that the user choose and if he choose “other” from the Extension Filter then you need to send the value “other” and you need to send PicExcludeExtentions filter. |
string | |||||||||||||||||||||||||||||||||
PicExcludeExtentions optional | This will be sent only if TypeFilter is set to other. | string | |||||||||||||||||||||||||||||||||
PicDimensionFilter optional | This filter used when TypeFilter is set to photo.
choose Dimension Filter which will return photos larger than the selected filter. If you send “Custom” then you will need to send CustomPicWidth filter and CustomPicHeight filter. for PicDimensionFilter .. Send the Value |
int |
|
||||||||||||||||||||||||||||||||
CustomPicWidth optional | This needs to be sent if PicDimensionFilter is set to custom. | long | |||||||||||||||||||||||||||||||||
CustomPicHeight optional | This needs to be sent if PicDimensionFilter is set to custom | long | |||||||||||||||||||||||||||||||||
PicCameraType optional | This filter value must contatin the camera full name ,This filter used if TypeFilter is set to "photo" and SearchFields is set to "Camera Name" | string | |||||||||||||||||||||||||||||||||
PicColorTypeFilter optional | This filter used if TypeFilter is set to photo
..
Send the Value |
int |
|
||||||||||||||||||||||||||||||||
PicDateCreation optional | This filter used TypeFilter is set to photo.
If you send “Custom” then you will need to send CustomPicCreationDateFrom filter and CustomPicCreationDateTo filter.
for PicDateCreation ..
Send the Value |
int |
|
||||||||||||||||||||||||||||||||
CustomPicCreationDateTo optional | This needs to be sent if PicDateCreation is set to custom | long | |||||||||||||||||||||||||||||||||
CustomPicCreationDateFrom optional | This needs to be sent if PicDateCreation is set to custom | long | |||||||||||||||||||||||||||||||||
SortType optional | filter the Sort type of the files to show.
Send the Value |
int |
|
||||||||||||||||||||||||||||||||
SearchTags optional | if sent as true, the search will get the files with specific tags | bool | |||||||||||||||||||||||||||||||||
IsFromTagSuggested optional | If sent true the result will be the files with the tag of "examlpe" And the files with the tags that contains the characters "examlpe" and you must send “SearchTags” Filter as true.
if send as false , the result will be the files with the tag of "example" only |
bool | |||||||||||||||||||||||||||||||||
FilterPath optional | Send the parent path to search in size specific folder. | string | |||||||||||||||||||||||||||||||||
SearchMode optional | This filter used to when you want to get files from Search/Browse/Favorites Files | int |
|
||||||||||||||||||||||||||||||||
TagType optional | This filter used for AI Tags and you must send "SearchTags" Filter as true to read this filter ..
Send the Value |
int |
|
Headers | Info | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
Parameter Name | Description | Type |
IsThereMore | Shows that is there more files on the next page or not | bool |
NextPageIndex | Shows From which file index the next page will start | int |
FileName | The File Name ( base64 ) | string |
FileGUID | The file GUID | string |
FileType | The Type of the file ( documents , video , audio , photos , ocr , folders , raw files ) | string |
FileName | The name Of the file | string |
Extension | The file extension | string |
FileSize | The size of the file in bytes | long |
ModificationDate | The file modification Date (FileTime UTC) | long |
IsFavoriteFile | Shows Is the file favorite or not | bool |
FilePath | The file full Path | string |
TranscodedSdSize | Shows the sd size in bytes for the vedio file. | long |
TranscodedHdSize | Shows the hd size in bytes for the vedio file. | long |
WidthResolution | Shows the width resolution for the video file. | int |
HieghtResolution | Shows the hieght resolution for the video file. | int |
ParentPath | The Parent File Path (Base64). | string |
IsFolder | indicats if the file is folder or not. | bool |
DocumentLanguage | Show the Document Language. | string |
PageCount | Shows the page count for the document file. | int |
SmallThumbURL | Shows the small thumb URL for images and videos (if exists) | string |
MeduimThumbURL | Shows the meduim thumb URL for images and videos (if exists) | string |
CroppedThumbURL | Shows the cropped thumb URL for images only (if exists) | string |
LargeThumbURL | Shows the Large thumb URL for images only (if exists) | string |
TranscodedVideoSdURL | Shows the sd video URL for the file. | string |
TranscodedVideoHdURL | Shows the hd video URL for videos that have HD video only (if exists) | string |
TranscodedAudioURL | Shows the audio URL for audio files only. | string |
IsColdFile | Shows if the file is a cold storage file or not. | bool |
DeviceName | The device name that the file belongs to. (base64) | string |
Header Name | Description | Type |
ResellerTokenrequired | The Reseller Token | string |
ClientID required | The client ID provided. | string |
ClientSecretrequired | The client secret provided. | string |
Actionrequired | The action name "GetFileInfo" | string |
DeviceGUIDrequired | The GUID of the required device. | string |
FileGUIDrequired | The GUID of the required file. | string |
Headers | Info | ||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||
ErrorMessage |
|
Parameter Name | Description | Type |
FileGUID | The file GUID | string |
FileType | The Type of the file ( documents , video , audio , photos , ocr , folders , raw files ) | string |
FileName | The File Name ( base64 ) | string |
FileFullPath | Shows the Full Path of the file ( base64 ). | string |
Extension | The file extension | string |
FileSize | The size of the file in bytes | long |
ModificationDate | The file modification Date (FileTime UTC) | long |
IsFavoriteFile | Shows Is the file favorite or not | bool |
TranscodedSdSize | Shows the sd size in bytes for the vedio file. | long |
TranscodedHdSize | Shows the hd size in bytes for the vedio file. | long |
WidthResolution | Shows the width resolution for the video file. | int |
HieghtResolution | Shows the hieght resolution for the video file. | int |
ParentPath | The Parent File Path (Base64). | string |
IsFolder | indicats if the file is folder or not. | bool |
DocumentLanguage | Show the Document Language. | string |
PageCount | Shows the page count for the document file. | int |
SmallThumbURL | Shows the small thumb URL for images and videos (if exists) | string |
MeduimThumbURL | Shows the meduim thumb URL for images and videos (if exists) | string |
CroppedThumbURL | Shows the cropped thumb URL for images only (if exists) | string |
LargeThumbURL | Shows the Large thumb URL for images only (if exists) | string |
TranscodedVideoSdURL | Shows the sd video URL for the file. | string |
TranscodedVideoHdURL | Shows the hd video URL for videos that have HD video only (if exists) | string |
TranscodedAudioURL | Shows the audio URL for audio files only. | string |
FileDownloadURL | Shows the original download URL for the file. | string |
Tags | Shows the file tags. | string array |
IsColdFile | Shows if the file is a cold storage file or not. | bool |
Camera | Shows the Camera Type of the file. | string |
DeviceName | Shows the device Name of the file. | string |
CreationDate | Shows the create date of the file (FileTime UTC). | long |
UploadDate | Shows the upload date of the file (FileTime UTC). | long |
Header Name | Description | Type |
ResellerTokenrequired | The Reseller Token | string |
ClientIDrequired | The client ID provided. | string |
ClientSecretrequired | The client secret provided. | string |
Actionrequired | The action name "AddTagsByFileGUID" | string |
DeviceGUIDrequired | The GUID of the required Device | string |
FileGUIDrequired | The GUID of the required File. | string |
Headers | Info | ||||||||||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
Header Name | Description | Type |
ResellerTokenrequired | The Reseller Token | string |
ClientIDrequired | The client ID provided. | string |
ClientSecretrequired | The client secret provided. | string |
Actionrequired | The action name "UpdateTagsByFileGUID" | string |
DeviceGUIDrequired | The GUID of the required Device | string |
FileGUIDrequired | The GUID of the required File. | string |
Headers | Info | ||||||||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
Header Name | Description | Type |
ResellerTokenrequired | The Reseller Token | string |
ClientIDrequired | The client ID provided. | string |
ClientSecretrequired | The client secret provided. | string |
Actionrequired | The action name "AddFavoriteFile" | string |
DeviceGUIDrequired | The GUID of the required Device. | string |
FileGUIDrequired | The GUID of the required File. | string |
Headers | Info | ||||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
Header Name | Description | Type |
ResellerTokenrequired | The Reseller Token | string |
ClientIDrequired | The client ID provided. | string |
ClientSecretrequired | The client secret provided. | string |
Actionrequired | The action name "RemoveFavoriteFile" | string |
DeviceGUIDrequired | The GUID of the required Device. | string |
FileGUIDrequired | The GUID of the required File. | string |
Headers | Info | ||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
Header Name | Description | Type | Values | ||||||||||||||||||||||||||||||||||||||||||||
ResellerTokenrequired | The Reseller Token | string | |||||||||||||||||||||||||||||||||||||||||||||
ClientIDrequired | The client ID provided. | string | |||||||||||||||||||||||||||||||||||||||||||||
ClientSecretrequired | The client secret provided. | string | |||||||||||||||||||||||||||||||||||||||||||||
Actionrequired | The action name"OCRFileByFileGUID" | string | |||||||||||||||||||||||||||||||||||||||||||||
DeviceGUIDrequired | The GUID of the required Device. | string | |||||||||||||||||||||||||||||||||||||||||||||
FileGUIDrequired | The GUID of the required File. | string | |||||||||||||||||||||||||||||||||||||||||||||
OCRLanguagerequired | The language Of the written Text in the file. Send the Value of the language as specified. | int |
|
Headers | Info | ||||||||||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
Header Name | Description | Type |
ResellerTokenrequired | The Reseller Token | string |
ClientIDrequired | The client ID provided. | string |
ClientSecretrequired | The client secret provided. | string |
Actionrequired | The action name "DeleteByFileGUID" | string |
DeviceGUIDrequired | The GUID of the required Device | string |
FileGUIDrequired | The GUID of the required File | string |
IsVersionoptional | The file is version or not. | bool |
Headers | Info | ||||||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
Header Name | Description | Type |
ResellerTokenrequired | The Reseller Token | string |
ClientIDrequired | The client ID provided. | string |
ClientSecretrequired | The client secret provided. | string |
Actionrequired | The action name "DeleteByFilePath" | string |
DeviceGUIDrequired | The GUID of the required Device. | string |
FilePathrequired | The Path of the required File. (Base64) | string |
Headers | Info | ||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
Header Name | Description | Type |
ResellerTokenrequired | The Reseller Token | string |
ClientIDrequired | The client ID provided. | string |
ClientSecretrequired | The client secret provided. | string |
Actionrequired | The action name"ListFilesByParentGUID" | string |
DeviceGUIDrequired | The GUID of the required Device | string |
FileGUID optional | The parent File GUID. | string |
PageIndexrequired | Page index number | int |
PageLimitrequired | number of files To Show in each page (max number is 1000) | int |
Headers | Info | ||||||||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
Parameter Name | Description | Type |
FullName | The File Name ( base64 ) | string |
FileFullPath | Shows the Full Path of the file ( base64 ). | string |
FileSize | Shows the size of the file by bytes. | long |
FileGUID | Shows the file GUID. | string |
IsFolder | indicats if the device is of type folder or not. | bool |
DeviceType | Shows the device main type ( PC = 0 , Vault = 1 , Mobile = 2 ). | int |
DeviceSubType | Shows the device sub type ( Desktop = 0 , Laptop = 1, Vault = 2, Android = 4, IPhone = 5 ) | int |
UploadDate | Shows the file upload date (FileTime UTC). | long |
ModificationDate | Shows the file modification date (FileTime UTC). If the file is of type folder then the value will be null. | long |
CreateDate | Shows the file create date (FileTime UTC). If the file is of type folder then the value will be null. | long |
Header Name | Description | Type |
ResellerTokenrequired | The Reseller Token | string |
ClientIDrequired | The client ID provided. | string |
ClientSecretrequired | The client secret provided. | string |
Actionrequired | The action name "ListAllFilesByParentGUID" | string |
DeviceGUIDrequired | The GUID of the required Device | string |
FileGUID optional | The parent File GUID. | string |
PageIndexrequired | Page index number | int |
PageLimitrequired | Number of files To Show in each page (max number is 1000) | int |
Headers | Info | ||||||||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
Parameter Name | Description | Type |
FullName | The File Name ( base64 ) | string |
FileFullPath | Shows the Full Path of the file ( base64 ). | string |
FileSize | Shows the size of the file by bytes. | int |
FileGUID | Shows the file GUID. | string |
IsFolder | Indicats if the device is of type folder or not. | string |
DeviceType | Shows the device main type ( PC = 0 , Vault = 1 , Mobile = 2 ). | int |
DeviceSubType | Shows the device sub type ( Desktop = 0 , Laptop = 1, Vault = 2, Android = 4, IPhone = 5 ) | int |
UploadDate | Shows the file upload date (FileTime UTC). | long |
ModificationDate | Shows the file modification date (FileTime UTC). If the file is of type folder then the value will be null. | long |
CreateDate | Shows the file create date (FileTime UTC). If the file is of type folder then the value will be null. | long |
Header Name | Description | Type |
ResellerTokenrequired | The Reseller Token | string |
ClientID required | The client ID provided. | string |
ClientSecretrequired | The client secret provided. | string |
Action required | The action name "ListFilesByParentPath" | string |
DeviceGUIDrequired | The GUID of the required Device | string |
ParentPathoptional | The Parent File Path (Base64). In case this header is not sent this API will return all the files in the selected device. | string |
PageIndexrequired | Page index number | int |
PageLimitrequired | Number of files To Show in each page (max number is 1000) | int |
Headers | Info | ||||||||||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
Parameter Name | Description | Type |
FullName | The File Name ( base64 ) | string |
FileFullPath | Shows the Full Path of the file ( base64 ). | string |
FileSize | Shows the size of the file by bytes. | int |
FileGUID | Shows the file GUID. | string |
IsFolder | indicats if the device is of type folder or not. | string |
DeviceType | Shows the device main type ( PC = 0 , Vault = 1 , Mobile = 2 ). | int |
DeviceSubType | Shows the device sub type ( Desktop = 0 , Laptop = 1, Vault = 2, Android = 4, IPhone = 5 ) | int |
UploadDate | Shows the file upload date (FileTime UTC). | long |
ModificationDate | Shows the file modification date (FileTime UTC). If the file is of type folder then the value will be null. | long |
CreateDate | Shows the file create date (FileTime UTC). If the file is of type folder then the value will be null. | long |
Header Name | Description | Type |
ResellerTokenrequired | The Reseller Token | string |
ClientIDrequired | The client ID provided. | string |
ClientSecretrequired | The client secret provided. | string |
Actionrequired | The action name "ListAllFilesByParentPath" | string |
DeviceGUIDrequired | The GUID of the required Device. | string |
ParentPathoptional | The Parent File Path (Base64). In case this header is not sent this API will return all the files in the selected device | string |
PageIndexrequired | Page index number. | int |
PageLimitrequired | Number of files To Show in each page (max number is 1000) | int |
Headers | Info | ||||||||||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
Parameter Name | Description | Type |
FullName | The File Name ( base64 ) | string |
FileFullPath | Shows the Full Path of the file ( base64 ). | string |
FileSize | Shows the size of the file by bytes. | int |
FileGUID | Shows the file GUID. | string |
IsFolder | indicats if the device is of type folder or not. | string |
DeviceType | Shows the device main type ( PC = 0 , Vault = 1 , Mobile = 2 ). | int |
DeviceSubType | Shows the device sub type ( Desktop = 0 , Laptop = 1, Vault = 2, Android = 4, IPhone = 5 ) | int |
UploadDate | Shows the file upload date (FileTime UTC). | long |
ModificationDate | Shows the file modification date (FileTime UTC). If the file is of type folder then the value will be null. | long |
CreateDate | Shows the file create date (FileTime UTC). If the file is of type folder then the value will be null. | long |
Header Name | Description | Type |
ResellerTokenrequired | The Reseller Token | string |
ClientIDrequired | The client ID provided. | string |
ClientSecretrequired | The client secret provided. | string |
Actionrequired | The action name "ListFileVersions" | string |
DeviceGUIDrequired | The GUID of the required Device | string |
FileGUIDrequired | The GUID of the required File | string |
PageIndexrequired | Page index number | int |
PageLimitrequired | number of files To Show in each page (max number is 1000) | int |
Headers | Info | ||||||||||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
Parameter Name | Description | Type |
FileName | The File Name ( base64 ) | string |
FileFullPath | Shows the Full Path of the file ( base64 ). | string |
FileSize | Shows the size of the file by bytes. | long |
VersionNumber | Shows the file Version Number. | int |
FileGUID | Shows the file GUID. | string |
IsFolder | indicats if the device is of type folder or not. | string |
DeviceType | Shows the device main type ( PC = 0 , Vault = 1 , Mobile = 2 ). | int |
DeviceSubType | Shows the device sub type ( Desktop = 0 , Laptop = 1, Vault = 2, Android = 4, IPhone = 5 ) | int |
IsThereMore | Shows that is there more files on the next page or not | bool |
NextPageIndex | Shows From which file index the next page will start | int |
UploadDate | Shows the file upload date (FileTime UTC). | long |
ModificationDate | Shows the file modification date (FileTime UTC). If the file is of type folder then the value will be null. | long |
CreateDate | Shows the file create date (FileTime UTC). If the file is of type folder then the value will be null. | long |
Header Name | Description | Type |
ResellerTokenrequired | The Reseller Token | string |
ClientID required | The client ID provided. | string |
ClientSecretrequired | The client secret provided. | string |
Actionrequired | The action name "ListFavoriteFiles" | string |
DeviceGUID optional | The GUID of the required device. | string |
PageIndexrequired | The page index | int |
PageLimitrequired | Files in each page limit (max number is 1000) | int |
Headers | Info | ||||||||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
Parameter Name | Description | Type |
FileGUID | Shows the file GUID. | string |
FileType | The Type of the file ( documents , video , audio , photos , ocr , folders , raw files ) | string |
FullName | The File Name ( base64 ) | string |
FileFullPath | Shows the Full Path of the file ( base64 ). | string |
Extension | The file extension | string |
FileSize | Shows the size of the file by bytes. | long |
ModificationDate | Shows the file Modification date. (UTC) | long |
ParentPath | The Parent File Path (Base64). | string |
IsFolder | indicats if the device is of type folder or not. | string |
PageCount | Shows the page count for the document file. | int |
DeviceName | The device name that the file belongs to. (base64) | string |
Header Name | Description | Type | Value | ||||||||||||||||||||||||||||||||||||||||||||
ResellerTokenrequired | The Reseller Token | string | |||||||||||||||||||||||||||||||||||||||||||||
DeviceGUIDrequired | The GUID of the required Device | string | |||||||||||||||||||||||||||||||||||||||||||||
ClientIDrequired | The client ID provided. | string | |||||||||||||||||||||||||||||||||||||||||||||
Action required | The action name "Upload" | string | |||||||||||||||||||||||||||||||||||||||||||||
ClientSecret required | The client secret provided. | string | |||||||||||||||||||||||||||||||||||||||||||||
ChunkSize optional | The size of the chunk that is being uploaded, default size is 8388608 bytes, maximum is 104857600 bytes. | int | |||||||||||||||||||||||||||||||||||||||||||||
ChunkOffset required | Determines from which byte the upload handler should resume upload the file. | int | |||||||||||||||||||||||||||||||||||||||||||||
IsLastrequired | Determins if the chunck being uploaded is the last or not. | bool | |||||||||||||||||||||||||||||||||||||||||||||
Tagsoptional | The file Tags ( base64 ) | string | |||||||||||||||||||||||||||||||||||||||||||||
IsFavouriteoptional | Determins if the File is Favourite or Not. | bool | |||||||||||||||||||||||||||||||||||||||||||||
IsOCRoptional | Determins if the File is OCR or Not. | bool | |||||||||||||||||||||||||||||||||||||||||||||
OCRLanguageoptional | The language Of the written Text in the file. this header is required if the header "IsOCR" is sent true. Send the Value of the language as specified. | int |
|
||||||||||||||||||||||||||||||||||||||||||||
FileSizerequired | The length of the file stream. | int | |||||||||||||||||||||||||||||||||||||||||||||
CreationDaterequired | The Creation date time. This header is not required in case the device is a cloud drive device this will be set to current time. |
string | |||||||||||||||||||||||||||||||||||||||||||||
ModificationDaterequired | The Modification date time. | string | |||||||||||||||||||||||||||||||||||||||||||||
FilePathrequired | the file path where we want to save the file in. (base64) | string |
Headers | Info | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FileGUID | The uploaded file GUID
This header will be retured if the file is only one chunk or its the last chunk request (if it's chuncked file) |
Header Name | Description | Type | Value |
ResellerTokenrequired | The Reseller Token | string | |
DeviceGUIDrequired | The GUID of the required Device | string | |
ClientIDrequired | The client ID provided. | string | |
Action required | The action name "UploadColdStorage" | string | |
ClientSecret required | The client secret provided. | string | |
ChunkSize optional | The size of the chunk that is being uploaded, default size is 8388608 bytes, maximum is 104857600 bytes. | int | |
ChunkOffset required | Determines from which byte the upload handler should resume upload the file. | int | |
IsLastrequired | Determins if the chunck being uploaded is the last or not. | bool | |
Tagsoptional | The file Tags ( base64 ) | string | |
FileSizerequired | The length of the file stream. | int | |
CreationDaterequired | The Creation date time. This header is not required in case the device is a cloud drive device this will be set to current time. |
string | |
ModificationDaterequired | The Modification date time. | string | |
FilePathrequired | the file path where we want to save the file in. (base64) | string |
Headers | Info | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FileGUID | The uploaded file GUID
This header will be retured if the file is only one chunk or its the last chunk request (if it's chuncked file) |
Header Name | Description | Type |
ResellerTokenrequired | The Reseller Token | string |
DeviceGUIDrequired | The GUID of the required Device. | string |
ClientIDrequired | The client ID provided. | string |
Actionrequired | The action name "DownloadSingleFile" | string |
ClientSecretrequired | The client secret provided. | string |
FileGUIDrequired | The file GUID. | string |
IsVersionrequired | The file is version or not. | bool |
Headers | Info | ||||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
Header Name | Description | Type |
ResellerTokenrequired | The Reseller Token | string |
DeviceGUIDrequired | The GUID of the required Device. | string |
ClientIDrequired | The client ID provided. | string |
Actionrequired | The action name "DownloadLinks" | string |
ClientSecretrequired | The client secret provided. | string |
Headers | Info | ||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
Parameter Name | Description | Type |
FileFullPath | Shows the Full Path of the file (base64). | string |
FileSize | Shows the size of the file by bytes. | int |
FileGUID | Shows the file GUID. | string |
FileDownloadURL | Shows the Download link for the file. | string |
Parameter Name | Description | Type |
ResellerTokenrequired | The Reseller Token | string |
DeviceGUIDrequired | The GUID of the required Device. | string |
ClientIDrequired | The client ID provided. | string |
ClientSecretrequired | The client secret provided. | string |
Actionrequired | The action name "RequestColdFilesDownload" | string |
VersionNumberoptional | Files version number. default is "-1" | int |
Headers | Info | ||||||||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
||||||||||||||||||||||||||||||||||||||||||
JobID | The requested Job ID |
Header Name | Description | Type |
ResellerTokenrequired | The Reseller Token | string |
DeviceGUIDrequired | The GUID of the required Device. | string |
ClientIDrequired | The client ID provided. | string |
ClientSecretrequired | The client secret provided. | string |
Actionrequired | The action name "CheckColdFilesJob" | string |
JobIDrequired | The JobID of the requested files. | int |
Headers | Info | ||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
Parameter Name | Description | Type | Values | ||||||||||
jobID | Shows the job ID. | int | |||||||||||
createDate | Shows the create date of the job. | long | |||||||||||
status | Shows the status of the job. | int |
|
Header Name | Description | Type |
ResellerTokenrequired | The Reseller Token | string |
DeviceGUIDrequired | The GUID of the required Device. | string |
ClientIDrequired | The client ID provided. | string |
ClientSecretrequired | The client secret provided. | string |
Actionrequired | The action name "ColdFilesDownloadLinks" | string |
JobIDrequired | The JobID of the requsted files. | int |
PageIndexrequired | Page index number. | int |
PageLimitrequired | Number of files To Show in each page (max number is 1000) | int |
Headers | Info | ||||||||||||||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||||||||||||||
ErrorMessage |
|
Parameter Name | Description | Type |
IsThereMore | Shows that is there more files on the next page or not | bool |
NextPageIndex | Shows From which file index the next page will start | int |
FileFullPath | Shows the Full Path of the file (base64). | string |
FileSize | Shows the size of the file by bytes. | int |
UploadDate | Shows the file upload date. (UTC) | long |
FileGUID | Shows the file GUID. | string |
FileDownloadURL | Shows the Download link for the file. | string |
Header Name | Description | Type | |
ResellerTokenrequired | The Reseller Token | string | |
DeviceGUIDrequired | The GUID of the required Device. | string | |
ClientIDrequired | The client ID provided. | string | |
ClientSecretrequired | The client secret provided. | string | |
Actionrequired | The action name "CreateFolder" | string | |
FullPathrequired | The full path that will be created, that will created all folders containing in path if not exists. (base64) | string | |
CreationDaterequired | The Creation date time. This header is not required in case the device is a cloud drive device this will be set to current time. |
string | |
ModificationDaterequired | The Modification date time. | string |
Headers | Info | ||||||||||||||||||||||||||||||||||||||
ErrorCode |
|
||||||||||||||||||||||||||||||||||||||
ErrorMessage |
|