Revision as of 12:00, 12 November 2018

Overview

The StorageHub REST interface provides a simple access to basic SH features.

Key features

Users must use the personal to access the REST interface. They can access just their own files and the folders shared with them.

StorageHub REST interface supports the following operations:

• Retrieve WS: to retrieve the user Workspace;
• Create Folder: to create a folder in the given parent folder;
• Delete: to remove a file or a folder (including subfolders);
• Download: to download a file or a folder in ZIP format;
• Get Public Link: to get a public link of a file;
• List: to list the content of a folder;
• Unzip: to upload a zip file in a specific folder;
• Upload file: to upload a file in a folder.

API

Retrieve Workspace

Returns the Item representing the workspace of the user retrieved by the token used for the call.

Java

 StorageHubClient shc = new StorageHubClient();
 FolderContainer rootContianer = shc.getWSRoot()

REST API

GET /workspace/?gcube-token={user-token}

responses

200 The workspace root item (in json format) is returned.

400 The error is specified in the body of the response message

Folder Listing

Returns the content of a Folder

Java

StorageHubClient shc = new StorageHubClient();
FolderContainer folderContainer = shc.open("{folderIdentifier}").asFolder();
List<? extends Item> items = folderContainer.list().getItems();

REST API

GET /workspace/items/{itemIdentifier}/?gcube-token={userToken}

parameters

{itemIdentifier} the identifier of the item to list the content

responses

200 the list of the Items (in JSON format)

400 The error is specified in the body of the response message