FileSystem API (v1)

Most current operations on files and folders, their metadata, and additional sharing features.

File System (Standard)

The most standard access to a filesystem located on the server.

/workspace_alias/ls/dir+
Standard listing action to retrieve the list of children for a given directory. For the main parameters, use {nodes} parameter, the {dir}+{file} are kept for backward compatibility.
Details
/workspace_alias/mkdir/file+
Creates a directory with name {dirname} at the given location.
Details
/workspace_alias/mkfile/node+
Creates a file at the given path. Optionally sets a content.
Details
/workspace_alias/upload/input_stream/dir+
Post a file content for upload, by default as x-www-form-urlencoded, but can be passed as input stream as well.
Details
/workspace_alias/download/file+
Download one or many files at once. If multiple files (or a folder path) passed, they are sent back as an archive.
Details
/workspace_alias/compress/file+
Compress one or many files into a Zip archive. May be disabled for remote-access workspaces (like FTP).
Details
/workspace_alias/stat/file+
Returns an fstat() structure
Details
/workspace_alias/lsync/
For externally modified files, triggers the node.change event in the platform
Details
/workspace_alias/apply_check_hook/hook_name/node+
Applies a node.before_create or node.before_change event to check for exemple that an upload is authorized before posting actual upload.
Details
/workspace_alias/get_content/node+
Alternative to Download, without attachment headers but more in a stream-like format, depending on file type (image, audio, video, plain text).
Details
/workspace_alias/put_content/node+
PUT the content inside a file, directly from the POST array.
Details
/workspace_alias/restore/node+
For an item located inside the recycle bin, tries to find its original location and move it there.
Details
/workspace_alias/rename/
Rename a resource, file or folder.
Details
/workspace_alias/copy/
Copy one or more items to a given target
Details
/workspace_alias/move/
Move a resource at a given target
Details
/workspace_alias/delete/nodes+
Delete one or more resources. If the workspace supports Recycle Bin features, resource is actually moved to the recycle bin.
Details
/workspace_alias/chmod/node+
Change the FS permissions of the selected item.
Details
/workspace_alias/prepare_chunk_dl/chunk_count/node+
Use the filesize of the file to generate an list of pieces to be downloaded using {download_chunk} action. Will generate a unique file_id to be used later.
Details
/workspace_alias/download_chunk/chunk_index/file_id
Chunk file into pieces before downloading the pieces. Can be handy for problematic and limited servers.
Details
/workspace_alias/purge/
If the workspace has a PURGE configured parameter, finds the expired files and delete them. Can be typically called from command line.
Details

Audio Player

Inserts a flash player for reading mp3 files online, and playing a whole folder in a separate window.

/workspace_alias/audio_proxy/file+
Server an audio file as a stream
Details

Image viewer

Image viewer, used for previewing images and browsing them in a diaporama. Generates a thumbnail version of the images.

/workspace_alias/preview_data_proxy/file+
Server an image with correct mimetype, eventually rendered as thumb.
Details

Image Magick

Image Magick viewer supports PDF and various images formats preview. Requires external library to be installed on the server.

/workspace_alias/imagick_data_proxy/file+
Serve JPG previews for a PDF or imagick-compatible file.
Details
/workspace_alias/get_extracted_page/file/src_file+
Server a prefetched thumbnail for a PDF or imagick compatible file. See imagick_data_proxy.
Details

Video Player

Inserts a video player in the info panel, either HTML5 or Flash depending on the format.

/workspace_alias/read_video_data/file+
Server a video file as a stream
Details

Power FS

This set of extensions assume that you have an administration access to your server: ability to tweak the webserver and the php configuration, ability to access the command line, etc.

/workspace_alias/compress/file+
Compress one or many files into a Zip archive. May be disabled for remote-access workspaces (like FTP).
Details

Sharing Features

Share Center actions and hooks

/workspace_alias/share/simple_share_type/file+
Main action for sharing a file or a folder
Details
/workspace_alias/load_shared_element_data/file+
Loads all current sharing data for a given resource. Workspace must support metadata management (metastore).
Details
/workspace_alias/unshare/file+
Stop sharing a folder, or remove a public link from a file.
Details
/workspace_alias/toggle_link_watch/file+
Toggle a shared element status for being watched or not.
Details
/workspace_alias/reset_counter/file+
Reset download counter for a given link generated on a file.
Details
/workspace_alias/sharelist-clearExpired/
Clear expired links
Details

Lucene Search Engine

Zend_Search_Lucene implementation to index all files and search a whole workspace quickly.

/workspace_alias/search/query
Search the Lucene index
Details
/workspace_alias/search_by_keyword/field/query
Search the Lucene on a specific document field
Details

Syncable Workspace

Track changes on this workspace to enable the synchronization with an external client

/workspace_alias/changes/seq_id
List all changes on this workspace starting at a given sequence id
Details
/workspace_alias/resync_storage/
Use the current index to compare with underlying storage and detect events
Details

Exif Metadata

Extracts the EXIF metadata of a JPG image. Used in conjunction with editor.exif

/workspace_alias/extract_exif/format/file+
Extract all exif data from a compatible image (JPG).
Details

Comments Feed

Display a chat-like feed on all nodes

/workspace_alias/load_comments_feed/file+
Load the comments on this file or below
Details
/workspace_alias/post_comment/file+
Post a comment linked to a given file
Details
/workspace_alias/delete_comment/
Delete a comment by reposting its json representation
Details

File Hasher

Compute on-demand a hash of the file content and stores it in the metadata if a metastore is provided

/workspace_alias/filehasher_signature/file+
Get the signature of an existing file
Details
/workspace_alias/filehasher_delta/file+
Compute a delta computed against an existing signature. Signature is posted as attached file (userfile_0)
Details
/workspace_alias/filehasher_patch/file+
Apply a patch to an existing file. Patch is posted as attached file (userfile_0)
Details
/workspace_alias/stat_hash/file+
Returns an fstat() structure including the hash of the file
Details

Git-based Versioning

Keep tracks of all files modifications using a local Git workspace

/workspace_alias/git_history/file+
Load the GIT history of this file
Details
/workspace_alias/git_getfile/file+
Download a given version of the file
Details
/workspace_alias/git_revertfile/file+
Revert a file to a given version in GIT
Details

User quota

Maintain the size of a given directory for each user

/workspace_alias/monitor_quota/
Get current quota usage information
Details

Simple Lock

Manual Locking mechanism to avoid concurrent edition

/workspace_alias/sl_lock/file+
Lock/Unlock a file for usage by other users.
Details

Text Metadata

Simple metadata implementation stored in a hidden file.

/workspace_alias/edit_user_meta/file+
Edit user-defined metadata on a node
Details

Watch Metadata

/workspace_alias/toggle_watch/file+
Set or unset a monitor watch on the selected node
Details

Pydio Documentation Library

Pydio v8