Atlas supports the classic CRUD database operations: Create, Read, Update, Delete. Each of these operations has a corresponding request method:
|Operation||Request method||Resource endpoint||Parameters / Payload|
|Json object in body|
|Array of json objects in body|
All objects, paged
|Pagination and simple filters in query string parameters|
|Object ID as url parameter|
|Complex filters in json payload|
|Full object as json in body|
|Array of objects as json in body|
|Array of ids as json in the body|
The following http verbs are unsupported. Usage of these verbs will result in a 405 - Method not allowed error:
PATCHis used for partially modify a resource. However it's unsupported on Atlas. Use the
PUTmethod to update objects, which requires providing the full object.
PATCH method is designed for partial updates, and is unsupported by the Atlas API. Instead, you must use the
PUT method for full object replacement when you want to update data.
PUT request is for full object replacement. So you must provide full objects with all fields to an endpoint in order to make an update. Not all fields are mutable. Those that are will take on the new values provided in the
PUT request. However, not all endpoints support the
PUT method. Those that don't are not mutable data. Examples include balances, transactions, positions, holdings, etc.
Most endpoints allow you to update a single object or multiple objects, using a
PUT method for both cases.
Updated 9 months ago