Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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.

...

Global Configuration

getConfig

Code Block
GET /cloudsync/api/rest/config

...

Code Block
PUT /cloudsync/api/rest/config

...

Users

createUser

Code Block
POST /cloudsync/api/rest/users

...

Code Block
DELETE /cloudsync/api/rest/users/{id}

...

Tasks

createTask

Code Block
POST /cloudsync/api/rest/tasks

...

Code Block
DELETE /cloudsync/api/rest/tasks/{id}

...

Sets

createSet

Code Block
POST /cloudsync/api/rest/sets

...

Code Block
DELETE /cloudsync/api/rest/sets/{id}

...

Stores

createStore

Code Block
POST /cloudsync/api/rest/stores

...

Code Block
DELETE /cloudsync/api/rest/stores/{id}

...

System Logs

...

listSysLogs

Code Block
GET /cloudsync/api/rest/tasklogssyslogs

...

getSysLog

Code Block
GET /cloudsync/api/rest/tasklogssyslogs/{id}

...

deleteSysLog

Code Block
DELETE /cloudsync/api/rest/taskslogssyslogs/{id}

...

Task Logs

...

listTaskLogs

Code Block
GET /cloudsync/api/rest/syslogstasklogs

...

getTaskLog

Code Block
GET /cloudsync/api/rest/syslogstasklogs/{id}

...

deleteTaskLog

Code Block
DELETE /cloudsync/api/rest/syslogstaskslogs/{id}