Programmer's Roadmap to the FAWAPI

 

API Operations

The following operations are currently available:

 

AppendChunk

Append a chunk of bytes to a file. The client must ensure that all messages are in sequence.

 

CopyItems

Copies items to the clipboard for pasting

 

CreateFolder

Creates a new folder

 

CutItems

Cuts items and moves it to the clipboard for pasting

 

DeleteItems

Deletes Items

 

DownloadFile

Provides a URL from which a file can be downloaded

 

ListItems

Lists all items in the specified path

 

ListUserVolumes

Lists all user volumes accessible from this account

 

Login

Logs you in to your FilesAnywhere account

 

Logout

Logs you out from your FilesAnywhere account

 

Paste

Pastes items in the clipboard into the specified path

 

RenameItem

Renames an Item

 

UploadFile

Upload a file

 

ItemProperties

Displays basic item attributes. This includes: the complete item path, the file size or folders and files count, item create date and the last updated date.

 

ItemAdvancedProperties

Displays advance item attributes. This includes: comments, the Version Control status if Version Control is enabled and thumbnail image.

 

ItemThumbnail

Displays a thumbnail for the item. For image files and documents indexed for the Online Viewer, the thumbnail will be a small picture of the first page of the file. For folders, a folder icon is returned.

ItemImage

Displays an image of the referenced page within the referenced file. This function only returns an image if the file is done indexing.

IndexedItemProperties

Displays a thumbnail for the item. For image files and documents indexed for the Online Viewer, the thumbnail will be a small picture of the first page of the file. For folders, a folder icon is returned.

RequestDocIndexing

Sends the system a request to index the referenced file. The system processes these requests in a queue. Once the document pages are indexed for viewing, the ItemImage function may be called to return the page image(s) in the file.

SendItemsElink

Shares files/folders securely with anyone, even non-members, using a web URL link. An email is sent with an encrypted web link, prompting the guest recipients to Download the shared files or folders as specified using this function.

 

FilesAnywhere API Topics

Alternatives: Automating the Easy Way

API Functionality

Service Description

Open Standards

Operations

Limitations

 

Download the complete FilesAnywhere API Specification