...
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.
- Store: Sources or sinks 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
...
.
Info |
---|
title | MIME Types and Status Codes |
---|
|
- 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.
|
...