DocumentApi
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| delete | DELETE /mongodb/collections/{collectionName}/documents/ | Delete Document from Collection |
| deleteMany | DELETE /mongodb/collections/{collectionName}/documents/many/delete | Delete Many in Collection |
| find | POST /mongodb/collections/{collectionName}/documents | Documents in Collection |
| getDocument | GET /mongodb/collections/{collectionName}/documents/ | Document from Collection |
| insert | PUT /mongodb/collections/{collectionName}/documents | Insert Document |
| insertMany | PUT /mongodb/collections/{collectionName}/documents/many/insert | Insert many Documents |
| listDocuments | GET /mongodb/collections/{collectionName}/documents | Documents in Collection |
| update | PATCH /mongodb/collections/{collectionName}/documents/ | Update Document in Collection |
| updateDocumentPartial | PATCH /mongodb/collections/{collectionName}/documents/{documentId}/partial | Update Document Parts in Collection |
| updateMany | PATCH /mongodb/collections/{collectionName}/documents/many/update | Update many in Collection |
delete
DeleteResponse delete(collectionName, documentId)
Delete Document from Collection
Delete one Document from given Collection
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | String | The name of your MongoDb Collection | [default to null] |
| documentId | String | DocumentId to delete | [default to null] |
Return type
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
deleteMany
DeleteResponse deleteMany(collectionName, request_body)
Delete Many in Collection
Delete many Document in given Collection
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | String | The name of your MongoDb Collection | [default to null] |
| request_body | Map |
Return type
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: application/json
- Accept: application/json, text/plain
find
List find(collectionName, MongoFindRequest, rowsPerPage, page)
Documents in Collection
Alternative to GET Route for more complex queries and URL max. Length
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | String | The name of your MongoDb Collection | [default to null] |
| MongoFindRequest | MongoFindRequest | ||
| rowsPerPage | Long | Count elements per page | [optional] [default to null] |
| page | Long | Requested page of the ResultSets | [optional] [default to null] |
Return type
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: application/json
- Accept: application/json, text/plain
getDocument
Map getDocument(collectionName, documentId)
Document from Collection
Get one Document from given Collection
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | String | The name of your MongoDb Collection | [default to null] |
| documentId | String | DocumentId to read | [default to null] |
Return type
Map
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
insert
InsertResponse insert(collectionName, request_body)
Insert Document
Insert one Document in given Collection
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | String | The name of your MongoDb Collection | [default to null] |
| request_body | Map | JSON Representation for your Document. |
Return type
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: application/json
- Accept: application/json, text/plain
insertMany
InsertResponse insertMany(collectionName, request_body)
Insert many Documents
Insert many documents in given Collection
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | String | The name of your MongoDb Collection | [default to null] |
| request_body | List | [optional] |
Return type
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: application/json
- Accept: application/json, text/plain
listDocuments
List listDocuments(collectionName, filter, sort, projection, rowsPerPage, page)
Documents in Collection
Get Documents paginated from given Collection
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | String | The name of your MongoDb Collection | [default to null] |
| filter | String | MongoDB Filter Query by Default all filter | [optional] [default to null] |
| sort | String | MongoDB sorting | [optional] [default to null] |
| projection | String | MongoDB projection | [optional] [default to null] |
| rowsPerPage | Long | Count elements per page | [optional] [default to null] |
| page | Long | Requested page of the ResultSets | [optional] [default to null] |
Return type
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, text/plain
update
UpdateResponse update(collectionName, documentId, request_body)
Update Document in Collection
'Replace' one Document with the new document from Request in Collection
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | String | The name of your MongoDb Collection | [default to null] |
| documentId | String | DocumentId to update | [default to null] |
| request_body | Map |
Return type
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: application/json
- Accept: application/json, text/plain
updateDocumentPartial
UpdateResponse updateDocumentPartial(collectionName, documentId, request_body)
Update Document Parts in Collection
Update the document Parts with the values from the Request
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | String | The name of your MongoDb Collection | [default to null] |
| documentId | String | DocumentId to update | [default to null] |
| request_body | Map |
Return type
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: application/json
- Accept: application/json, text/plain
updateMany
UpdateResponse updateMany(collectionName, UpdateRequest)
Update many in Collection
Update many Document in given Collection
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | String | The name of your MongoDb Collection | [default to null] |
| UpdateRequest | UpdateRequest |
Return type
Authorization
httpAuth1, httpAuth, apiKeyAuth
HTTP request headers
- Content-Type: application/json
- Accept: application/json, text/plain