HTTP Methods¶
The API supports the following HTTP methods:
GET
Used to query a resource or a list of resource.
POST
Used to create a new resource.
The data is submitted as a JSON object.
The return value is the pkid of the resource.
PUT
Used to update the data of a resource.
The resource URL includes the resource pkid.
The data to be updated is submitted as a JSON object.
PATCH
Used to update the data of a resource.
PATCH request body in JSON Patch format
Content-Type is “application/json-patch+json”
JSON Patch: http://tools.ietf.org/html/rfc6902
DELETE
Used to delete a resource.
The resource URL includes the resource pkid.
The DELETE method can also be used to delete multiple resources on one request as a “bulk delete”.