DataApi

All URIs are relative to http://localhost:4001

Method	HTTP request	Description
abortTransaction	POST /app-api/v1/data/transaction/abort	Aborts a transaction
commitTransaction	POST /app-api/v1/data/transaction/commit	Commits a transaction
createDocument	POST /app-api/v1/data/colls/{coll}/docs	Creates one document in database
createTransaction	POST /app-api/v1/data/transaction	Creates a transaction
deleteCollection	DELETE /app-api/v1-api/v1/data/colls/{coll}	Deletes a collection from database
deleteDocumentById	DELETE /app-api/v1/data/colls/{coll}/docs/{id}	Deletes a document from database
findDocuments	POST /app-api/v1/data/colls/{coll}/find	Finds documents in database
getDocumentById	GET /app-api/v1/data/colls/{coll}/docs/{id}	Gets a document from database
getDocuments	GET /app-api/v1/data/colls/{coll}/docs	Gets documents from database
insertManyDocuments	POST /app-api/v1/data/colls/{coll}/insertMany	Inserts many documents in database
updateDocumentById	PUT /app-api/v1/data/colls/{coll}/docs/{id}	Updates a document in database
updateManyDocuments	POST /app-api/v1/data/colls/{coll}/updateMany	Updates many documents in database

abortTransaction

abortTransaction()

Aborts a transaction

Example

// Import classes:
import io.lenra.api.internal.ApiClient;
import io.lenra.api.internal.ApiException;
import io.lenra.api.internal.Configuration;
import io.lenra.api.internal.auth.*;
import io.lenra.api.internal.models.*;
import io.lenra.api.internal.client.DataApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:4001");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    DataApi apiInstance = new DataApi(defaultClient);
    try {
      apiInstance.abortTransaction();
    } catch (ApiException e) {
      System.err.println("Exception when calling DataApi#abortTransaction");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Transaction aborted	-

commitTransaction

commitTransaction()

Commits a transaction

Example

// Import classes:
import io.lenra.api.internal.ApiClient;
import io.lenra.api.internal.ApiException;
import io.lenra.api.internal.Configuration;
import io.lenra.api.internal.auth.*;
import io.lenra.api.internal.models.*;
import io.lenra.api.internal.client.DataApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:4001");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    DataApi apiInstance = new DataApi(defaultClient);
    try {
      apiInstance.commitTransaction();
    } catch (ApiException e) {
      System.err.println("Exception when calling DataApi#commitTransaction");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Transaction commited	-

createDocument

Map<String, Object> createDocument(coll, body)

Creates one document in database

Example

// Import classes:
import io.lenra.api.internal.ApiClient;
import io.lenra.api.internal.ApiException;
import io.lenra.api.internal.Configuration;
import io.lenra.api.internal.auth.*;
import io.lenra.api.internal.models.*;
import io.lenra.api.internal.client.DataApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:4001");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    DataApi apiInstance = new DataApi(defaultClient);
    String coll = "coll_example"; // String | The document collection name
    Object body = null; // Object | The document to create
    try {
      Map<String, Object> result = apiInstance.createDocument(coll, body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataApi#createDocument");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
coll	String	The document collection name
body	Object	The document to create

Return type

Map<String, Object>

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Document created	-

createTransaction

String createTransaction()

Creates a transaction

Example

// Import classes:
import io.lenra.api.internal.ApiClient;
import io.lenra.api.internal.ApiException;
import io.lenra.api.internal.Configuration;
import io.lenra.api.internal.auth.*;
import io.lenra.api.internal.models.*;
import io.lenra.api.internal.client.DataApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:4001");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    DataApi apiInstance = new DataApi(defaultClient);
    try {
      String result = apiInstance.createTransaction();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataApi#createTransaction");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Transaction created	-

deleteCollection

deleteCollection(coll)

Deletes a collection from database

Example

// Import classes:
import io.lenra.api.internal.ApiClient;
import io.lenra.api.internal.ApiException;
import io.lenra.api.internal.Configuration;
import io.lenra.api.internal.auth.*;
import io.lenra.api.internal.models.*;
import io.lenra.api.internal.client.DataApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:4001");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    DataApi apiInstance = new DataApi(defaultClient);
    String coll = "coll_example"; // String | The document collection name
    try {
      apiInstance.deleteCollection(coll);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataApi#deleteCollection");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
coll	String	The document collection name

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Collection deleted	-

deleteDocumentById

Map<String, Object> deleteDocumentById(coll, id)

Deletes a document from database

Example

// Import classes:
import io.lenra.api.internal.ApiClient;
import io.lenra.api.internal.ApiException;
import io.lenra.api.internal.Configuration;
import io.lenra.api.internal.auth.*;
import io.lenra.api.internal.models.*;
import io.lenra.api.internal.client.DataApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:4001");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    DataApi apiInstance = new DataApi(defaultClient);
    String coll = "coll_example"; // String | The document collection name
    String id = "id_example"; // String | The document identifier
    try {
      Map<String, Object> result = apiInstance.deleteDocumentById(coll, id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataApi#deleteDocumentById");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
coll	String	The document collection name
id	String	The document identifier

Return type

Map<String, Object>

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Document deleted	-

findDocuments

List<Map<String, Object>> findDocuments(coll, findDocumentsRequest)

Finds documents in database

Example

// Import classes:
import io.lenra.api.internal.ApiClient;
import io.lenra.api.internal.ApiException;
import io.lenra.api.internal.Configuration;
import io.lenra.api.internal.auth.*;
import io.lenra.api.internal.models.*;
import io.lenra.api.internal.client.DataApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:4001");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    DataApi apiInstance = new DataApi(defaultClient);
    String coll = "coll_example"; // String | The document collection name
    FindDocumentsRequest findDocumentsRequest = new FindDocumentsRequest(); // FindDocumentsRequest | The query to find documents
    try {
      List<Map<String, Object>> result = apiInstance.findDocuments(coll, findDocumentsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataApi#findDocuments");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
coll	String	The document collection name
findDocumentsRequest	FindDocumentsRequest	The query to find documents

Return type

List<Map<String, Object>>

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Documents found	-

getDocumentById

Map<String, Object> getDocumentById(coll, id)

Gets a document from database

Example

// Import classes:
import io.lenra.api.internal.ApiClient;
import io.lenra.api.internal.ApiException;
import io.lenra.api.internal.Configuration;
import io.lenra.api.internal.auth.*;
import io.lenra.api.internal.models.*;
import io.lenra.api.internal.client.DataApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:4001");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    DataApi apiInstance = new DataApi(defaultClient);
    String coll = "coll_example"; // String | The document collection name
    String id = "id_example"; // String | The document identifier
    try {
      Map<String, Object> result = apiInstance.getDocumentById(coll, id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataApi#getDocumentById");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
coll	String	The document collection name
id	String	The document identifier

Return type

Map<String, Object>

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Document created	-

getDocuments

List<Map<String, Object>> getDocuments(coll)

Gets documents from database

Example

// Import classes:
import io.lenra.api.internal.ApiClient;
import io.lenra.api.internal.ApiException;
import io.lenra.api.internal.Configuration;
import io.lenra.api.internal.auth.*;
import io.lenra.api.internal.models.*;
import io.lenra.api.internal.client.DataApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:4001");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    DataApi apiInstance = new DataApi(defaultClient);
    String coll = "coll_example"; // String | The document collection name
    try {
      List<Map<String, Object>> result = apiInstance.getDocuments(coll);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataApi#getDocuments");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
coll	String	The document collection name

Return type

List<Map<String, Object>>

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Documents found	-

insertManyDocuments

InsertManyDocuments200Response insertManyDocuments(coll, insertManyDocumentsRequest)

Inserts many documents in database

Example

// Import classes:
import io.lenra.api.internal.ApiClient;
import io.lenra.api.internal.ApiException;
import io.lenra.api.internal.Configuration;
import io.lenra.api.internal.auth.*;
import io.lenra.api.internal.models.*;
import io.lenra.api.internal.client.DataApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:4001");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    DataApi apiInstance = new DataApi(defaultClient);
    String coll = "coll_example"; // String | The documents collection name
    InsertManyDocumentsRequest insertManyDocumentsRequest = new InsertManyDocumentsRequest(); // InsertManyDocumentsRequest | The documents to create
    try {
      InsertManyDocuments200Response result = apiInstance.insertManyDocuments(coll, insertManyDocumentsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataApi#insertManyDocuments");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
coll	String	The documents collection name
insertManyDocumentsRequest	InsertManyDocumentsRequest	The documents to create

Return type

InsertManyDocuments200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Documents inserted	-

updateDocumentById

Map<String, Object> updateDocumentById(coll, id, requestBody)

Updates a document in database

Example

// Import classes:
import io.lenra.api.internal.ApiClient;
import io.lenra.api.internal.ApiException;
import io.lenra.api.internal.Configuration;
import io.lenra.api.internal.auth.*;
import io.lenra.api.internal.models.*;
import io.lenra.api.internal.client.DataApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:4001");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    DataApi apiInstance = new DataApi(defaultClient);
    String coll = "coll_example"; // String | The document collection name
    String id = "id_example"; // String | The document identifier
    Map<String, Object> requestBody = null; // Map<String, Object> | The document to update
    try {
      Map<String, Object> result = apiInstance.updateDocumentById(coll, id, requestBody);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataApi#updateDocumentById");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
coll	String	The document collection name
id	String	The document identifier
requestBody	Map<String, Object>	The document to update

Return type

Map<String, Object>

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Document updated	-

updateManyDocuments

Object updateManyDocuments(coll, updateManyDocumentsRequest)

Updates many documents in database

Example

// Import classes:
import io.lenra.api.internal.ApiClient;
import io.lenra.api.internal.ApiException;
import io.lenra.api.internal.Configuration;
import io.lenra.api.internal.auth.*;
import io.lenra.api.internal.models.*;
import io.lenra.api.internal.client.DataApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:4001");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    DataApi apiInstance = new DataApi(defaultClient);
    String coll = "coll_example"; // String | The document collection name
    UpdateManyDocumentsRequest updateManyDocumentsRequest = new UpdateManyDocumentsRequest(); // UpdateManyDocumentsRequest | The query to find documents
    try {
      Object result = apiInstance.updateManyDocuments(coll, updateManyDocumentsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DataApi#updateManyDocuments");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
coll	String	The document collection name
updateManyDocumentsRequest	UpdateManyDocumentsRequest	The query to find documents

Return type

Object

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Documents updated	-

Files

DataApi.md

Latest commit

History

DataApi.md

File metadata and controls

DataApi

abortTransaction

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

commitTransaction

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createDocument

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createTransaction

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteCollection

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteDocumentById

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

findDocuments

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getDocumentById

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getDocuments

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

insertManyDocuments

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateDocumentById

Example

Parameters