Document
In this guide
Document resources enable you to work with individual documents in a database. The following table lists the document resources:
| HTTP method | URI pattern | Description |
|---|---|---|
POST
|
/{db}
| Creates a new document in the database |
PUT
|
/{db}/{doc}
| Creates a new document or updates an existing document |
GET
|
/{db}/{doc}
| Retrieves a document |
DELETE
|
/{db}/{doc}
| Deletes a document |
PUT
|
/{db}/{doc}/{attachment}
| Adds or updates attachments for a document |
GET
|
/{db}/{doc}/{attachment}
| Retrieves attachments for a document |
DELETE
|
/{db}/{doc}/{attachment}
| Deletes attachments for a document |
The following table defines the parameters used in the URI patterns:
| Name | Description |
|---|---|
attachment
| Identifier of an attachment |
db
| Name of the database |
doc
| Identifier of a document |
Articles
- POST /{db}
- Create a new document
- PUT /{db}/{doc}
- Create or update a document
- GET /{db}/{doc}
- Retrieve a document
- DELETE /{db}/{doc}
- Delete a document
- PUT /{db}/{doc}/{attachment}
- Add or update an attachment
- GET /{db}/{doc}/{attachment}
- Retrieve an attachment
- DELETE /{db}/{doc}/{attachment}
- Delete an attachment