CollectionApi

All URIs are relative to http://localhost

Method	HTTP request	Description
aggregate	POST /mongodb/collections/{collectionName}/aggregate	Aggregate in Collection
clearCollection	DELETE /mongodb/collections/{collectionName}/clear	Clear Collection
deleteCollection	DELETE /mongodb/collections/	Delete Collection
distinct	POST /mongodb/collections/{collectionName}/distinct/	Distinct in Collection
getCollectionFields	GET /mongodb/collections/{collectionName}/fields	Collection Fields
getCollectionInformation	GET /mongodb/collections/	Collection Information
getJsonSchema	GET /mongodb/collections/{collectionName}/schema	Collection Fields
getSchemaAnalysis	GET /mongodb/collections/{collectionName}/schema/analysis	Collection Fields
listCollections	GET /mongodb/collections	List of Collections
listCollectionsByDatabase	GET /mongodb/databases/{databaseName}/collections	List of Collections

aggregate

List aggregate(collectionName, MongoAggregateRequest, rowsPerPage, page)

Aggregate in Collection

Aggregate in a given Collection

Parameters

Name	Type	Description	Notes
collectionName	String	The name of your MongoDb Collection	[default to null]
MongoAggregateRequest	MongoAggregateRequest
rowsPerPage	Long	Count elements per page	[optional] [default to null]
page	Long	Requested page of the ResultSets	[optional] [default to null]

Return type

List

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, text/plain

clearCollection

JsonValue_Boolean clearCollection(collectionName)

Clear Collection

Delete all Document in Collection

Parameters

Name	Type	Description	Notes
collectionName	String	The name of your MongoDb Collection	[default to null]

Return type

JsonValue_Boolean

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deleteCollection

JsonValue_Boolean deleteCollection(collectionName)

Delete Collection

Delete a given Collection

Parameters

Name	Type	Description	Notes
collectionName	String	The name of your MongoDb Collection	[default to null]

Return type

JsonValue_Boolean

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

distinct

List distinct(collectionName, field, rowsPerPage, page)

Distinct in Collection

Distinct for Field in a given Collection

Parameters

Name	Type	Description	Notes
collectionName	String	The name of your MongoDb Collection	[default to null]
field	String	The field for your distinct Request.	[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

List

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/plain

getCollectionFields

List getCollectionFields(collectionName, sample size)

Collection Fields

List the Fields in a given collection

Parameters

Name	Type	Description	Notes
collectionName	String	The name of your MongoDb Collection	[default to null]
sample size	Integer	Use sample size greater 0 (e.g. 1000) for better performance on big collections	[optional] [default to null]

Return type

List

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/plain

getCollectionInformation

CollectionStatus getCollectionInformation(collectionName, includeDetails)

Collection Information

All Information about a single Collection

Parameters

Name	Type	Description	Notes
collectionName	String	The name of your MongoDb Collection	[default to null]
includeDetails	Boolean	Include all details for the Collection	[optional] [default to false]

Return type

CollectionStatus

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/plain

getJsonSchema

JsonSchema getJsonSchema(collectionName, sampleSize, deepth)

Collection Fields

List the Fields in a given collection

Parameters

Name	Type	Description	Notes
collectionName	String	The name of your MongoDb Collection	[default to null]
sampleSize	Integer	Use sample size greater 0 (e.g. 5000) for better performance on big collections	[optional] [default to null]
deepth	Integer	How deep should the objects extracted	[optional] [default to 3]

Return type

JsonSchema

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/plain

getSchemaAnalysis

SchemaAnalysis getSchemaAnalysis(collectionName, sampleSize, deepth)

Collection Fields

List the Fields in a given collection

Parameters

Name	Type	Description	Notes
collectionName	String	The name of your MongoDb Collection	[default to null]
sampleSize	Integer	Use sample size greater 0 (e.g. 5000) for better performance on big collections	[optional] [default to null]
deepth	Integer	How deep should the objects extracted	[optional] [default to 3]

Return type

SchemaAnalysis

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/plain

listCollections

List listCollections()

List of Collections

List of all Collections of the default database

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

listCollectionsByDatabase

List listCollectionsByDatabase(databaseName)

List of Collections

List of all Collections of the given database

Parameters

Name	Type	Description	Notes
databaseName	String	Name of your Database	[default to null]

Return type

List

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json