net.leanix.api.DocumentsApi Maven / Gradle / Ivy
package net.leanix.api;
import net.leanix.api.common.ApiException;
import net.leanix.api.common.ApiClient;
import net.leanix.api.common.Configuration;
import net.leanix.api.common.Pair;
import javax.ws.rs.core.GenericType;
import net.leanix.api.models.Document;
import net.leanix.api.models.DataObject;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class DocumentsApi {
private ApiClient apiClient;
public DocumentsApi() {
this(Configuration.getDefaultApiClient());
}
public DocumentsApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
public ApiClient getApiClient() {
return apiClient;
}
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* Create a new Document
*
* @param body Message-Body (optional)
* @return Document
* @throws ApiException if fails to make API call
*/
public Document createDocument(Document body) throws ApiException {
Object localVarPostBody = body;
// create path and map variables
String localVarPath = "/documents".replaceAll("\\{format\\}","json");
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { };
GenericType localVarReturnType = new GenericType() {};
return apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* Delete a Document by a given ID
*
* @param ID Unique ID (required)
* @throws ApiException if fails to make API call
*/
public void deleteDocument(String ID) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'ID' is set
if (ID == null) {
throw new ApiException(400, "Missing the required parameter 'ID' when calling deleteDocument");
}
// create path and map variables
String localVarPath = "/documents/{ID}".replaceAll("\\{format\\}","json")
.replaceAll("\\{" + "ID" + "\\}", apiClient.escapeString(ID.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { };
apiClient.invokeAPI(localVarPath, "DELETE", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, null);
}
/**
* Read a Document by a given ID
*
* @param ID Unique ID (required)
* @param relations If set to true, all relations of the Fact Sheet are fetched as well. Fetching all relations can be slower. Default: false. (optional, default to false)
* @return Document
* @throws ApiException if fails to make API call
*/
public Document getDocument(String ID, Boolean relations) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'ID' is set
if (ID == null) {
throw new ApiException(400, "Missing the required parameter 'ID' when calling getDocument");
}
// create path and map variables
String localVarPath = "/documents/{ID}".replaceAll("\\{format\\}","json")
.replaceAll("\\{" + "ID" + "\\}", apiClient.escapeString(ID.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("", "relations", relations));
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { };
GenericType localVarReturnType = new GenericType() {};
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* Read all documents
*
* @param relations If set to true, all relations of the Fact Sheet are fetched as well. Fetching all relations can be slower. Default: false. (optional, default to false)
* @param filter Full-text filter (optional)
* @param referenceSystem Reference system filter (optional)
* @param referenceID ReferenceID, e.g. Signavio ID (optional)
* @param factSheetID FactSheetID, e.g. LeanIX ID (optional)
* @return List
* @throws ApiException if fails to make API call
*/
public List getDocuments(Boolean relations, String filter, String referenceSystem, String referenceID, String factSheetID) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/documents".replaceAll("\\{format\\}","json");
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("", "relations", relations));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "filter", filter));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "referenceSystem", referenceSystem));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "referenceID", referenceID));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "factSheetID", factSheetID));
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { };
GenericType> localVarReturnType = new GenericType>() {};
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* Update the data object for the given document ID
*
* @param ID Unique ID (required)
* @param body Message-Body (optional)
* @return DataObject
* @throws ApiException if fails to make API call
*/
public DataObject updateDataObject(String ID, DataObject body) throws ApiException {
Object localVarPostBody = body;
// verify the required parameter 'ID' is set
if (ID == null) {
throw new ApiException(400, "Missing the required parameter 'ID' when calling updateDataObject");
}
// create path and map variables
String localVarPath = "/documents/{ID}/dataobjects".replaceAll("\\{format\\}","json")
.replaceAll("\\{" + "ID" + "\\}", apiClient.escapeString(ID.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { };
GenericType localVarReturnType = new GenericType() {};
return apiClient.invokeAPI(localVarPath, "PUT", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* Update a Document by a given ID
*
* @param ID Unique ID (required)
* @param body Message-Body (optional)
* @return Document
* @throws ApiException if fails to make API call
*/
public Document updateDocument(String ID, Document body) throws ApiException {
Object localVarPostBody = body;
// verify the required parameter 'ID' is set
if (ID == null) {
throw new ApiException(400, "Missing the required parameter 'ID' when calling updateDocument");
}
// create path and map variables
String localVarPath = "/documents/{ID}".replaceAll("\\{format\\}","json")
.replaceAll("\\{" + "ID" + "\\}", apiClient.escapeString(ID.toString()));
// query params
List localVarQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { };
GenericType localVarReturnType = new GenericType() {};
return apiClient.invokeAPI(localVarPath, "PUT", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy