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.

Operations on

...

Global Configuration

getConfig

Code Block
GET /cloudsync/api/rest/config

updateConfig

Code Block
PUT /cloudsync/api/rest/config

Operations on Users

createUser

Code Block
POST /cloudsync/api/rest/tasksusers

...

listUsers

Code Block
GET /cloudsync/api/rest/tasksusers

...

getUser

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

...

updateUser

Code Block
PUT /cloudsync/api/rest/tasksusers/{id}

...

deleteUser

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

Operations on

...

Tasks

createTask

Code Block
POST /cloudsync/api/rest/tasks

listTasks

Code Block
GET /cloudsync/api/rest/tasklogstasks

...

getTask

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

updateTask

Code Block
PUT /cloudsync/api/rest/tasklogstasks/{id}

...

deleteTask

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

Operations on Sets

createSet

...

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

Operations on

...

Task Logs

...

listTaskLogs

Code Block
GET /cloudsync/api/rest/config

updateConfig

Code Block
PUT /cloudsync/api/rest/config

Operations on Users

createUser

Code Block
POST /cloudsync/api/rest/users

listUsers

tasklogs

getTaskLog

Code Block
Code Block
GET /cloudsync/api/rest/users

getUser

Code Block
GET /cloudsync/api/rest/users/tasklogs/{id}

...

deleteTaskLog

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

deleteUser

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

Operations on System Logs

...