You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 22
Next »
Contents:
High Level Design
Web UI Mockups
REST API Design
Introduction
The CloudSync REST API is a web-accessible, resource-oriented API that exposes operations on the key entities of the service:
- Tasks: Define work that is to be performed or is currently being performed.
- Task Logs: Raw, text/plain logs of running or completed tasks.
- Sets: Specifications of groups of Fedora Objects for use with tasks.
- Stores: Sources or destinations of Fedora Objects and Datastreams.
- Global Configuration: Properties that affect the global behavior of the application.
- User Preferences: Properties that affect an individiaul user's experience of the application.
- System Logs: Raw, text/plain logs of the application. Includes everything except Task Logs.
The exact attributes and representations of these entities have not yet been determined.
The base URL of all REST API operations is the URL of the cloudsync app, plus /api/rest/. For example:
http://example.org/cloudsync/api/rest/
Common MIME Types, Status Codes, and Response Headers
- Unless otherwise stated, requests and responses will always be in JSON or XML format. The default format is XML ("application/xml") unless ".json" is specified at the end of the URL or content negotiation is used to denote a preference for the "application/json" MIME type.
- When GET is used to retrieve information about a resource, success is indicated by a 200 OK response code.
- When POST is used to add a resource (e.g. addTask), a successful (201 Created) response will include a Content-Location header that provides the URI of the new resource. The last portion of that URI will be the newly-allocated id of that resource, which is an opaque, URI-safe string.
- When PUT is used to update a resource (e.g. updateTask), success is indicated by a 200 OK response code, and the response body will be the updated representation of the resource, as if requested via GET.
- When DELETE is used to remove a resource (e.g. deleteTask), success is indicated by a 204 No Content response code, and the response body will be empty.
Operations on Tasks
createTask
POST /cloudsync/api/rest/tasks
listTasks
GET /cloudsync/api/rest/tasks
getTask
GET /cloudsync/api/rest/tasks/{id}
updateTask
PUT /cloudsync/api/rest/tasks/{id}
deleteTask
DELETE /cloudsync/api/rest/tasks/{id}
Operations on Task Logs
listTaskLogs
GET /cloudsync/api/rest/tasklogs
getTaskLog
GET /cloudsync/api/rest/tasklogs/{id}
deleteTaskLog
DELETE /cloudsync/api/rest/taskslogs/{id}
Operations on Sets
createSet
POST /cloudsync/api/rest/sets
listSets
GET /cloudsync/api/rest/sets
getSet
GET /cloudsync/api/rest/sets/{id}
updateSet
PUT /cloudsync/api/rest/sets/{id}
deleteSet
DELETE /cloudsync/api/rest/sets/{id}
Operations on Stores
createStore
POST /cloudsync/api/rest/stores
listStores
GET /cloudsync/api/rest/stores
getStore
GET /cloudsync/api/rest/stores/{id}
queryStore
GET /cloudsync/api/rest/stores/{id}/objects[?set={set-id}&limit={limit}&offset={offset}]
updateStore
PUT /cloudsync/api/rest/stores/{id}
deleteStore
DELETE /cloudsync/api/rest/stores/{id}
Operations on Global Configuration
getConfig
GET /cloudsync/api/rest/config
updateConfig
PUT /cloudsync/api/rest/config
Operations on User Preferences
getPrefs
GET /cloudsync/api/rest/prefs
updatePrefs
PUT /cloudsync/api/rest/prefs
Operations on System Logs
listSysLogs
GET /cloudsync/api/rest/syslogs
getSysLog
GET /cloudsync/api/rest/syslogs/{id}
deleteSysLog
DELETE /cloudsync/api/rest/syslogs/{id}