...
The CloudSync REST API is a web-accessible, resource-oriented API that exposes operations on the key entities of the service:
- Configuration: Properties that affect the global behavior of the application.
- Users: Users that can login to the application. Includes per-user preferences.
- Tasks: Define work that is to be performed or is currently being performed.
- Task Logs: Raw, text/plain logs of running or completed tasks.
- Object Sets: Specifications of groups of Fedora Objects for use with tasks.
- Object Stores: Sources or destinations of Fedora Objects and Datastreams.
- Configuration: Properties that affect the global behavior of the application.
- Users: Users that can login to the application. Includes per-user preferencesassociated Datastreams.
- System Logs: Raw, text/plain logs of the application. Includes everything except Task Logs.
- Task Logs: Raw, text/plain logs of running or completed tasks.
The exact attributes and representations of these entities have not yet been determined.
...
- 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.
...
Configuration
...
getConfiguration
| Code Block |
|---|
GET /cloudsync/api/rest/configconfiguration |
...
updateConfiguration
| Code Block |
|---|
PUT /cloudsync/api/rest/configconfiguration |
Users
createUser
| Code Block |
|---|
POST /cloudsync/api/rest/users |
...
| Code Block |
|---|
DELETE /cloudsync/api/rest/tasks/{id} |
Object Sets
createSet
| Code Block |
|---|
POST /cloudsync/api/rest/setsobjectsets |
listSets
| Code Block |
|---|
GET /cloudsync/api/rest/setsobjectsets |
getSet
| Code Block |
|---|
GET /cloudsync/api/rest/setsobjectsets/{id} |
updateSet
| Code Block |
|---|
PUT /cloudsync/api/rest/setsobjectsets/{id} |
deleteSet
| Code Block |
|---|
DELETE /cloudsync/api/rest/setsobjectsets/{id} |
Object Stores
createStore
| Code Block |
|---|
POST /cloudsync/api/rest/storesobjectstores |
listStores
| Code Block |
|---|
GET /cloudsync/api/rest/storesobjectstores |
getStore
| Code Block |
|---|
GET /cloudsync/api/rest/storesobjectstores/{id} |
queryStore
| Code Block |
|---|
GET /cloudsync/api/rest/storesobjectstores/{id}/objects[?set={setobjectset-id}&limit={limit}&offset={offset}] |
...
