Conventions

HTTP Verbs

Standard HTTP Verbs are used in relation to an API resource to communicate a desired action.

Note that because not all clients/browsers support all HTTP verbs, there are various priority orders by which the applicable verb is determined:

1. The _method POST variable: Issue any request as a POST and it will be interpreted as another verb so long as that verb is specified in _method.
2. The X_HTTP_METHOD_OVERRIDE request header
3. The REQUEST_METHOD header request header

GET

Fetch a single object or list of objects for a resource. For example, GETting /v1/workspaces will retrieve a list of all workspace objects, while /v1/workspaces/1 will retrieve the workspace object with an ID of 1.

POST

Create a new object. For example, POSTing to /v1/workspaces will create a new workspace object.

PUT

Update an existing object. For example, PUTting to /v1/workspaces/1 will updating the existing workspace object with an ID of 1.

DELETE

Delete an existing object. For example, DELETEing /v1/workspaces/1 will delete the workspace object with an ID of 1.

OPTIONS

Used for Cross-Origin Resource Sharing.