6.5 HP StoreAll OS User Guide

Uses for the StoreAll REST API
Although the StoreAll REST API is not generally intended for your end users, it lets you create
applications using the StoreAll file systems and Express Query.
You can develop applications that:
• Gather user input and send requests programmatically to StoreAll
• Digest responses from StoreAll and present results to user in a readable format
• Can be coded in any language for example, Java or python, on any client operating system,
such as Windows or Linux.
Certain tools let you send ad-hoc direct requests and show responses:
• Web browsers with add-ons, curl, and others. You must enter request data in the StoreAll
REST API syntax.
• Sample Java client application provided by HP to guide customer developers. See “Obtaining
the HP StoreAll REST API Sample Client Application” (page 176) for information on how to
access the sample Java client.
Features for each file share mode
The following table provides supported features for each type of file share mode:
Table 24 Supported features for each share node
Object modeFile-Compatible mode
Standard HTTP share (no
REST API)Features
XXXFile upload/download
XXFile system hierarchy stored
as-is on a StoreAll file system
No access by other
protocols
XXAccess by other protocols,
such as SMB and NFS
XAccount and container
partitioning of objects
XObjects that do not fit into a
file system hierarchy (files
stored opaquely on the
StoreAll file system)
No Express QueryXExpress Query metadata DB
for:
• System/custom metadata
queries
• Custom metadata
assignment
• WORM/Retention
management
Best practices for HTTP REST API shares
Keep in mind the following best practices for file-compatible and object mode shares:
• Do not put file-compatible and object mode shares on the same filesystem.
• Avoid putting object mode shares on retention-enabled file systems, unless the auto-commit
feature is needed. The object mode API does not include retention management features.
Managing WORM or retention states must be performed outside the API as described in
“Managing data retention” (page 274).
Uses for the StoreAll REST API 175