Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Camunda BPM REST API
* OpenApi Spec for Camunda BPM REST API.
*
* The version of the OpenAPI document: 7.14.0-alpha4
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package org.openapitools.client.api;
import org.openapitools.client.ApiCallback;
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.ApiResponse;
import org.openapitools.client.Configuration;
import org.openapitools.client.Pair;
import org.openapitools.client.ProgressRequestBody;
import org.openapitools.client.ProgressResponseBody;
import com.google.gson.reflect.TypeToken;
import java.io.IOException;
import org.openapitools.client.model.CountResultDto;
import java.util.Date;
import org.openapitools.client.model.DeploymentDto;
import org.openapitools.client.model.DeploymentResourceDto;
import org.openapitools.client.model.DeploymentWithDefinitionsDto;
import org.openapitools.client.model.ExceptionDto;
import java.io.File;
import org.openapitools.client.model.ParseExceptionDto;
import org.openapitools.client.model.RedeploymentDto;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class DeploymentApi {
private ApiClient localVarApiClient;
public DeploymentApi() {
this(Configuration.getDefaultApiClient());
}
public DeploymentApi(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
public ApiClient getApiClient() {
return localVarApiClient;
}
public void setApiClient(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
/**
* Build call for createDeployment
* @param tenantId The tenant id for the deployment to be created. (optional)
* @param deploymentSource The source for the deployment to be created. (optional)
* @param deployChangedOnly A flag indicating whether the process engine should perform duplicate checking on a per-resource basis. If set to true, only those resources that have actually changed are deployed. Checks are made against resources included previous deployments of the same name and only against the latest versions of those resources. If set to true, the option enable-duplicate-filtering is overridden and set to true. (optional, default to false)
* @param enableDuplicateFiltering A flag indicating whether the process engine should perform duplicate checking for the deployment or not. This allows you to check if a deployment with the same name and the same resouces already exists and if true, not create a new deployment but instead return the existing deployment. The default value is false. (optional, default to false)
* @param deploymentName The name for the deployment to be created. (optional)
* @param data The binary data to create the deployment resource. It is possible to have more than one form part with different form part names for the binary data to create a deployment. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
400
Bad Request. In case one of the bpmn resources cannot be parsed. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#parse-exceptions) for the error response format.
-
*/
public okhttp3.Call createDeploymentCall(String tenantId, String deploymentSource, Boolean deployChangedOnly, Boolean enableDuplicateFiltering, String deploymentName, File data, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/deployment/create";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (tenantId != null) {
localVarFormParams.put("tenant-id", tenantId);
}
if (deploymentSource != null) {
localVarFormParams.put("deployment-source", deploymentSource);
}
if (deployChangedOnly != null) {
localVarFormParams.put("deploy-changed-only", deployChangedOnly);
}
if (enableDuplicateFiltering != null) {
localVarFormParams.put("enable-duplicate-filtering", enableDuplicateFiltering);
}
if (deploymentName != null) {
localVarFormParams.put("deployment-name", deploymentName);
}
if (data != null) {
localVarFormParams.put("data", data);
}
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"multipart/form-data"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { };
return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call createDeploymentValidateBeforeCall(String tenantId, String deploymentSource, Boolean deployChangedOnly, Boolean enableDuplicateFiltering, String deploymentName, File data, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = createDeploymentCall(tenantId, deploymentSource, deployChangedOnly, enableDuplicateFiltering, deploymentName, data, _callback);
return localVarCall;
}
/**
*
* Creates a deployment. **Security Consideration** Deployments can contain custom code in form of scripts or EL expressions to customize process behavior. This may be abused for remote execution of arbitrary code.
* @param tenantId The tenant id for the deployment to be created. (optional)
* @param deploymentSource The source for the deployment to be created. (optional)
* @param deployChangedOnly A flag indicating whether the process engine should perform duplicate checking on a per-resource basis. If set to true, only those resources that have actually changed are deployed. Checks are made against resources included previous deployments of the same name and only against the latest versions of those resources. If set to true, the option enable-duplicate-filtering is overridden and set to true. (optional, default to false)
* @param enableDuplicateFiltering A flag indicating whether the process engine should perform duplicate checking for the deployment or not. This allows you to check if a deployment with the same name and the same resouces already exists and if true, not create a new deployment but instead return the existing deployment. The default value is false. (optional, default to false)
* @param deploymentName The name for the deployment to be created. (optional)
* @param data The binary data to create the deployment resource. It is possible to have more than one form part with different form part names for the binary data to create a deployment. (optional)
* @return DeploymentWithDefinitionsDto
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
400
Bad Request. In case one of the bpmn resources cannot be parsed. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#parse-exceptions) for the error response format.
-
*/
public DeploymentWithDefinitionsDto createDeployment(String tenantId, String deploymentSource, Boolean deployChangedOnly, Boolean enableDuplicateFiltering, String deploymentName, File data) throws ApiException {
ApiResponse localVarResp = createDeploymentWithHttpInfo(tenantId, deploymentSource, deployChangedOnly, enableDuplicateFiltering, deploymentName, data);
return localVarResp.getData();
}
/**
*
* Creates a deployment. **Security Consideration** Deployments can contain custom code in form of scripts or EL expressions to customize process behavior. This may be abused for remote execution of arbitrary code.
* @param tenantId The tenant id for the deployment to be created. (optional)
* @param deploymentSource The source for the deployment to be created. (optional)
* @param deployChangedOnly A flag indicating whether the process engine should perform duplicate checking on a per-resource basis. If set to true, only those resources that have actually changed are deployed. Checks are made against resources included previous deployments of the same name and only against the latest versions of those resources. If set to true, the option enable-duplicate-filtering is overridden and set to true. (optional, default to false)
* @param enableDuplicateFiltering A flag indicating whether the process engine should perform duplicate checking for the deployment or not. This allows you to check if a deployment with the same name and the same resouces already exists and if true, not create a new deployment but instead return the existing deployment. The default value is false. (optional, default to false)
* @param deploymentName The name for the deployment to be created. (optional)
* @param data The binary data to create the deployment resource. It is possible to have more than one form part with different form part names for the binary data to create a deployment. (optional)
* @return ApiResponse<DeploymentWithDefinitionsDto>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
400
Bad Request. In case one of the bpmn resources cannot be parsed. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#parse-exceptions) for the error response format.
-
*/
public ApiResponse createDeploymentWithHttpInfo(String tenantId, String deploymentSource, Boolean deployChangedOnly, Boolean enableDuplicateFiltering, String deploymentName, File data) throws ApiException {
okhttp3.Call localVarCall = createDeploymentValidateBeforeCall(tenantId, deploymentSource, deployChangedOnly, enableDuplicateFiltering, deploymentName, data, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* (asynchronously)
* Creates a deployment. **Security Consideration** Deployments can contain custom code in form of scripts or EL expressions to customize process behavior. This may be abused for remote execution of arbitrary code.
* @param tenantId The tenant id for the deployment to be created. (optional)
* @param deploymentSource The source for the deployment to be created. (optional)
* @param deployChangedOnly A flag indicating whether the process engine should perform duplicate checking on a per-resource basis. If set to true, only those resources that have actually changed are deployed. Checks are made against resources included previous deployments of the same name and only against the latest versions of those resources. If set to true, the option enable-duplicate-filtering is overridden and set to true. (optional, default to false)
* @param enableDuplicateFiltering A flag indicating whether the process engine should perform duplicate checking for the deployment or not. This allows you to check if a deployment with the same name and the same resouces already exists and if true, not create a new deployment but instead return the existing deployment. The default value is false. (optional, default to false)
* @param deploymentName The name for the deployment to be created. (optional)
* @param data The binary data to create the deployment resource. It is possible to have more than one form part with different form part names for the binary data to create a deployment. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
400
Bad Request. In case one of the bpmn resources cannot be parsed. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#parse-exceptions) for the error response format.
-
*/
public okhttp3.Call createDeploymentAsync(String tenantId, String deploymentSource, Boolean deployChangedOnly, Boolean enableDuplicateFiltering, String deploymentName, File data, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = createDeploymentValidateBeforeCall(tenantId, deploymentSource, deployChangedOnly, enableDuplicateFiltering, deploymentName, data, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for deleteDeployment
* @param id The id of the deployment to be deleted. (required)
* @param cascade `true`, if all process instances, historic process instances and jobs for this deployment should be deleted. (optional, default to false)
* @param skipCustomListeners `true`, if only the built-in ExecutionListeners should be notified with the end event. (optional, default to false)
* @param skipIoMappings `true`, if all input/output mappings should not be invoked. (optional, default to false)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
204
Request successful.
-
404
A Deployment with the provided id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call deleteDeploymentCall(String id, Boolean cascade, Boolean skipCustomListeners, Boolean skipIoMappings, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/deployment/{id}"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
if (cascade != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("cascade", cascade));
}
if (skipCustomListeners != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("skipCustomListeners", skipCustomListeners));
}
if (skipIoMappings != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("skipIoMappings", skipIoMappings));
}
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { };
return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call deleteDeploymentValidateBeforeCall(String id, Boolean cascade, Boolean skipCustomListeners, Boolean skipIoMappings, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling deleteDeployment(Async)");
}
okhttp3.Call localVarCall = deleteDeploymentCall(id, cascade, skipCustomListeners, skipIoMappings, _callback);
return localVarCall;
}
/**
*
* Deletes a deployment by id.
* @param id The id of the deployment to be deleted. (required)
* @param cascade `true`, if all process instances, historic process instances and jobs for this deployment should be deleted. (optional, default to false)
* @param skipCustomListeners `true`, if only the built-in ExecutionListeners should be notified with the end event. (optional, default to false)
* @param skipIoMappings `true`, if all input/output mappings should not be invoked. (optional, default to false)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
204
Request successful.
-
404
A Deployment with the provided id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public void deleteDeployment(String id, Boolean cascade, Boolean skipCustomListeners, Boolean skipIoMappings) throws ApiException {
deleteDeploymentWithHttpInfo(id, cascade, skipCustomListeners, skipIoMappings);
}
/**
*
* Deletes a deployment by id.
* @param id The id of the deployment to be deleted. (required)
* @param cascade `true`, if all process instances, historic process instances and jobs for this deployment should be deleted. (optional, default to false)
* @param skipCustomListeners `true`, if only the built-in ExecutionListeners should be notified with the end event. (optional, default to false)
* @param skipIoMappings `true`, if all input/output mappings should not be invoked. (optional, default to false)
* @return ApiResponse<Void>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
204
Request successful.
-
404
A Deployment with the provided id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public ApiResponse deleteDeploymentWithHttpInfo(String id, Boolean cascade, Boolean skipCustomListeners, Boolean skipIoMappings) throws ApiException {
okhttp3.Call localVarCall = deleteDeploymentValidateBeforeCall(id, cascade, skipCustomListeners, skipIoMappings, null);
return localVarApiClient.execute(localVarCall);
}
/**
* (asynchronously)
* Deletes a deployment by id.
* @param id The id of the deployment to be deleted. (required)
* @param cascade `true`, if all process instances, historic process instances and jobs for this deployment should be deleted. (optional, default to false)
* @param skipCustomListeners `true`, if only the built-in ExecutionListeners should be notified with the end event. (optional, default to false)
* @param skipIoMappings `true`, if all input/output mappings should not be invoked. (optional, default to false)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
204
Request successful.
-
404
A Deployment with the provided id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call deleteDeploymentAsync(String id, Boolean cascade, Boolean skipCustomListeners, Boolean skipIoMappings, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = deleteDeploymentValidateBeforeCall(id, cascade, skipCustomListeners, skipIoMappings, _callback);
localVarApiClient.executeAsync(localVarCall, _callback);
return localVarCall;
}
/**
* Build call for getDeployment
* @param id The id of the deployment. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
404
Deployment with given id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call getDeploymentCall(String id, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/deployment/{id}"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getDeploymentValidateBeforeCall(String id, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling getDeployment(Async)");
}
okhttp3.Call localVarCall = getDeploymentCall(id, _callback);
return localVarCall;
}
/**
*
* Retrieves a deployment by id, according to the `Deployment` interface of the engine.
* @param id The id of the deployment. (required)
* @return List<DeploymentDto>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
404
Deployment with given id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public List getDeployment(String id) throws ApiException {
ApiResponse> localVarResp = getDeploymentWithHttpInfo(id);
return localVarResp.getData();
}
/**
*
* Retrieves a deployment by id, according to the `Deployment` interface of the engine.
* @param id The id of the deployment. (required)
* @return ApiResponse<List<DeploymentDto>>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
404
Deployment with given id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public ApiResponse> getDeploymentWithHttpInfo(String id) throws ApiException {
okhttp3.Call localVarCall = getDeploymentValidateBeforeCall(id, null);
Type localVarReturnType = new TypeToken>(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* (asynchronously)
* Retrieves a deployment by id, according to the `Deployment` interface of the engine.
* @param id The id of the deployment. (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
404
Deployment with given id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call getDeploymentAsync(String id, final ApiCallback> _callback) throws ApiException {
okhttp3.Call localVarCall = getDeploymentValidateBeforeCall(id, _callback);
Type localVarReturnType = new TypeToken>(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getDeploymentResource
* @param id The id of the deployment (required)
* @param resourceId The id of the deployment resource (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
404
Deployment Resource with given resource id or deployment id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call getDeploymentResourceCall(String id, String resourceId, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/deployment/{id}/resources/{resourceId}"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()))
.replaceAll("\\{" + "resourceId" + "\\}", localVarApiClient.escapeString(resourceId.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getDeploymentResourceValidateBeforeCall(String id, String resourceId, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling getDeploymentResource(Async)");
}
// verify the required parameter 'resourceId' is set
if (resourceId == null) {
throw new ApiException("Missing the required parameter 'resourceId' when calling getDeploymentResource(Async)");
}
okhttp3.Call localVarCall = getDeploymentResourceCall(id, resourceId, _callback);
return localVarCall;
}
/**
*
* Retrieves a deployment resource by resource id for the given deployment.
* @param id The id of the deployment (required)
* @param resourceId The id of the deployment resource (required)
* @return DeploymentResourceDto
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
404
Deployment Resource with given resource id or deployment id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public DeploymentResourceDto getDeploymentResource(String id, String resourceId) throws ApiException {
ApiResponse localVarResp = getDeploymentResourceWithHttpInfo(id, resourceId);
return localVarResp.getData();
}
/**
*
* Retrieves a deployment resource by resource id for the given deployment.
* @param id The id of the deployment (required)
* @param resourceId The id of the deployment resource (required)
* @return ApiResponse<DeploymentResourceDto>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
404
Deployment Resource with given resource id or deployment id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public ApiResponse getDeploymentResourceWithHttpInfo(String id, String resourceId) throws ApiException {
okhttp3.Call localVarCall = getDeploymentResourceValidateBeforeCall(id, resourceId, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* (asynchronously)
* Retrieves a deployment resource by resource id for the given deployment.
* @param id The id of the deployment (required)
* @param resourceId The id of the deployment resource (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
404
Deployment Resource with given resource id or deployment id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call getDeploymentResourceAsync(String id, String resourceId, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getDeploymentResourceValidateBeforeCall(id, resourceId, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getDeploymentResourceData
* @param id The id of the deployment. (required)
* @param resourceId The id of the deployment resource. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful. The media type of the response depends on the filename.
-
400
Deployment Resource with given resource id or deployment id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call getDeploymentResourceDataCall(String id, String resourceId, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/deployment/{id}/resources/{resourceId}/data"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()))
.replaceAll("\\{" + "resourceId" + "\\}", localVarApiClient.escapeString(resourceId.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/octet-stream", "*/*", "application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getDeploymentResourceDataValidateBeforeCall(String id, String resourceId, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling getDeploymentResourceData(Async)");
}
// verify the required parameter 'resourceId' is set
if (resourceId == null) {
throw new ApiException("Missing the required parameter 'resourceId' when calling getDeploymentResourceData(Async)");
}
okhttp3.Call localVarCall = getDeploymentResourceDataCall(id, resourceId, _callback);
return localVarCall;
}
/**
*
* Retrieves the binary content of a deployment resource for the given deployment by id.
* @param id The id of the deployment. (required)
* @param resourceId The id of the deployment resource. (required)
* @return File
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful. The media type of the response depends on the filename.
-
400
Deployment Resource with given resource id or deployment id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public File getDeploymentResourceData(String id, String resourceId) throws ApiException {
ApiResponse localVarResp = getDeploymentResourceDataWithHttpInfo(id, resourceId);
return localVarResp.getData();
}
/**
*
* Retrieves the binary content of a deployment resource for the given deployment by id.
* @param id The id of the deployment. (required)
* @param resourceId The id of the deployment resource. (required)
* @return ApiResponse<File>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful. The media type of the response depends on the filename.
-
400
Deployment Resource with given resource id or deployment id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public ApiResponse getDeploymentResourceDataWithHttpInfo(String id, String resourceId) throws ApiException {
okhttp3.Call localVarCall = getDeploymentResourceDataValidateBeforeCall(id, resourceId, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* (asynchronously)
* Retrieves the binary content of a deployment resource for the given deployment by id.
* @param id The id of the deployment. (required)
* @param resourceId The id of the deployment resource. (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful. The media type of the response depends on the filename.
-
400
Deployment Resource with given resource id or deployment id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call getDeploymentResourceDataAsync(String id, String resourceId, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getDeploymentResourceDataValidateBeforeCall(id, resourceId, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getDeploymentResources
* @param id The id of the deployment to retrieve the deployment resources for. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
404
Deployment resources for the given deployment do not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call getDeploymentResourcesCall(String id, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/deployment/{id}/resources"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getDeploymentResourcesValidateBeforeCall(String id, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling getDeploymentResources(Async)");
}
okhttp3.Call localVarCall = getDeploymentResourcesCall(id, _callback);
return localVarCall;
}
/**
*
* Retrieves all deployment resources of a given deployment.
* @param id The id of the deployment to retrieve the deployment resources for. (required)
* @return List<DeploymentResourceDto>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
404
Deployment resources for the given deployment do not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public List getDeploymentResources(String id) throws ApiException {
ApiResponse> localVarResp = getDeploymentResourcesWithHttpInfo(id);
return localVarResp.getData();
}
/**
*
* Retrieves all deployment resources of a given deployment.
* @param id The id of the deployment to retrieve the deployment resources for. (required)
* @return ApiResponse<List<DeploymentResourceDto>>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
404
Deployment resources for the given deployment do not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public ApiResponse> getDeploymentResourcesWithHttpInfo(String id) throws ApiException {
okhttp3.Call localVarCall = getDeploymentResourcesValidateBeforeCall(id, null);
Type localVarReturnType = new TypeToken>(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* (asynchronously)
* Retrieves all deployment resources of a given deployment.
* @param id The id of the deployment to retrieve the deployment resources for. (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
404
Deployment resources for the given deployment do not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call getDeploymentResourcesAsync(String id, final ApiCallback> _callback) throws ApiException {
okhttp3.Call localVarCall = getDeploymentResourcesValidateBeforeCall(id, _callback);
Type localVarReturnType = new TypeToken>(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getDeployments
* @param id Filter by deployment id (optional)
* @param name Filter by the deployment name. Exact match. (optional)
* @param nameLike Filter by the deployment name that the parameter is a substring of. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
* @param source Filter by the deployment source. (optional)
* @param withoutSource Filter by the deployment source whereby source is equal to `null`. (optional, default to false)
* @param tenantIdIn Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids. (optional)
* @param withoutTenantId Only include deployments which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param includeDeploymentsWithoutTenantId Include deployments which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param after Restricts to all deployments after the given date. By [default](https://docs.camunda.org/manual/latest/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
* @param before Restricts to all deployments before the given date. By [default](https://docs.camunda.org/manual/latest/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
* @param sortBy Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
* @param sortOrder Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
* @param firstResult Pagination of results. Specifies the index of the first result to return. (optional)
* @param maxResults Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
400
Returned if some of the query parameters are invalid, for example if a `sortOrder` parameter is supplied, but no `sortBy`, or if an invalid operator for variable comparison is used. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call getDeploymentsCall(String id, String name, String nameLike, String source, Boolean withoutSource, String tenantIdIn, Boolean withoutTenantId, Boolean includeDeploymentsWithoutTenantId, Date after, Date before, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/deployment";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
if (id != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("id", id));
}
if (name != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("name", name));
}
if (nameLike != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("nameLike", nameLike));
}
if (source != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("source", source));
}
if (withoutSource != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("withoutSource", withoutSource));
}
if (tenantIdIn != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("tenantIdIn", tenantIdIn));
}
if (withoutTenantId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("withoutTenantId", withoutTenantId));
}
if (includeDeploymentsWithoutTenantId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("includeDeploymentsWithoutTenantId", includeDeploymentsWithoutTenantId));
}
if (after != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("after", after));
}
if (before != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("before", before));
}
if (sortBy != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("sortBy", sortBy));
}
if (sortOrder != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("sortOrder", sortOrder));
}
if (firstResult != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("firstResult", firstResult));
}
if (maxResults != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("maxResults", maxResults));
}
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getDeploymentsValidateBeforeCall(String id, String name, String nameLike, String source, Boolean withoutSource, String tenantIdIn, Boolean withoutTenantId, Boolean includeDeploymentsWithoutTenantId, Date after, Date before, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getDeploymentsCall(id, name, nameLike, source, withoutSource, tenantIdIn, withoutTenantId, includeDeploymentsWithoutTenantId, after, before, sortBy, sortOrder, firstResult, maxResults, _callback);
return localVarCall;
}
/**
*
* Queries for deployments that fulfill given parameters. Parameters may be the properties of deployments, such as the id or name or a range of the deployment time. The size of the result set can be retrieved by using the [Get Deployment count](https://docs.camunda.org/manual/latest/reference/rest/deployment/get-query-count/) method.
* @param id Filter by deployment id (optional)
* @param name Filter by the deployment name. Exact match. (optional)
* @param nameLike Filter by the deployment name that the parameter is a substring of. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
* @param source Filter by the deployment source. (optional)
* @param withoutSource Filter by the deployment source whereby source is equal to `null`. (optional, default to false)
* @param tenantIdIn Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids. (optional)
* @param withoutTenantId Only include deployments which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param includeDeploymentsWithoutTenantId Include deployments which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param after Restricts to all deployments after the given date. By [default](https://docs.camunda.org/manual/latest/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
* @param before Restricts to all deployments before the given date. By [default](https://docs.camunda.org/manual/latest/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
* @param sortBy Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
* @param sortOrder Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
* @param firstResult Pagination of results. Specifies the index of the first result to return. (optional)
* @param maxResults Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
* @return List<DeploymentDto>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
400
Returned if some of the query parameters are invalid, for example if a `sortOrder` parameter is supplied, but no `sortBy`, or if an invalid operator for variable comparison is used. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public List getDeployments(String id, String name, String nameLike, String source, Boolean withoutSource, String tenantIdIn, Boolean withoutTenantId, Boolean includeDeploymentsWithoutTenantId, Date after, Date before, String sortBy, String sortOrder, Integer firstResult, Integer maxResults) throws ApiException {
ApiResponse> localVarResp = getDeploymentsWithHttpInfo(id, name, nameLike, source, withoutSource, tenantIdIn, withoutTenantId, includeDeploymentsWithoutTenantId, after, before, sortBy, sortOrder, firstResult, maxResults);
return localVarResp.getData();
}
/**
*
* Queries for deployments that fulfill given parameters. Parameters may be the properties of deployments, such as the id or name or a range of the deployment time. The size of the result set can be retrieved by using the [Get Deployment count](https://docs.camunda.org/manual/latest/reference/rest/deployment/get-query-count/) method.
* @param id Filter by deployment id (optional)
* @param name Filter by the deployment name. Exact match. (optional)
* @param nameLike Filter by the deployment name that the parameter is a substring of. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
* @param source Filter by the deployment source. (optional)
* @param withoutSource Filter by the deployment source whereby source is equal to `null`. (optional, default to false)
* @param tenantIdIn Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids. (optional)
* @param withoutTenantId Only include deployments which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param includeDeploymentsWithoutTenantId Include deployments which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param after Restricts to all deployments after the given date. By [default](https://docs.camunda.org/manual/latest/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
* @param before Restricts to all deployments before the given date. By [default](https://docs.camunda.org/manual/latest/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
* @param sortBy Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
* @param sortOrder Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
* @param firstResult Pagination of results. Specifies the index of the first result to return. (optional)
* @param maxResults Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
* @return ApiResponse<List<DeploymentDto>>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
400
Returned if some of the query parameters are invalid, for example if a `sortOrder` parameter is supplied, but no `sortBy`, or if an invalid operator for variable comparison is used. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public ApiResponse> getDeploymentsWithHttpInfo(String id, String name, String nameLike, String source, Boolean withoutSource, String tenantIdIn, Boolean withoutTenantId, Boolean includeDeploymentsWithoutTenantId, Date after, Date before, String sortBy, String sortOrder, Integer firstResult, Integer maxResults) throws ApiException {
okhttp3.Call localVarCall = getDeploymentsValidateBeforeCall(id, name, nameLike, source, withoutSource, tenantIdIn, withoutTenantId, includeDeploymentsWithoutTenantId, after, before, sortBy, sortOrder, firstResult, maxResults, null);
Type localVarReturnType = new TypeToken>(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* (asynchronously)
* Queries for deployments that fulfill given parameters. Parameters may be the properties of deployments, such as the id or name or a range of the deployment time. The size of the result set can be retrieved by using the [Get Deployment count](https://docs.camunda.org/manual/latest/reference/rest/deployment/get-query-count/) method.
* @param id Filter by deployment id (optional)
* @param name Filter by the deployment name. Exact match. (optional)
* @param nameLike Filter by the deployment name that the parameter is a substring of. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
* @param source Filter by the deployment source. (optional)
* @param withoutSource Filter by the deployment source whereby source is equal to `null`. (optional, default to false)
* @param tenantIdIn Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids. (optional)
* @param withoutTenantId Only include deployments which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param includeDeploymentsWithoutTenantId Include deployments which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param after Restricts to all deployments after the given date. By [default](https://docs.camunda.org/manual/latest/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
* @param before Restricts to all deployments before the given date. By [default](https://docs.camunda.org/manual/latest/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
* @param sortBy Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
* @param sortOrder Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
* @param firstResult Pagination of results. Specifies the index of the first result to return. (optional)
* @param maxResults Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
400
Returned if some of the query parameters are invalid, for example if a `sortOrder` parameter is supplied, but no `sortBy`, or if an invalid operator for variable comparison is used. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call getDeploymentsAsync(String id, String name, String nameLike, String source, Boolean withoutSource, String tenantIdIn, Boolean withoutTenantId, Boolean includeDeploymentsWithoutTenantId, Date after, Date before, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, final ApiCallback> _callback) throws ApiException {
okhttp3.Call localVarCall = getDeploymentsValidateBeforeCall(id, name, nameLike, source, withoutSource, tenantIdIn, withoutTenantId, includeDeploymentsWithoutTenantId, after, before, sortBy, sortOrder, firstResult, maxResults, _callback);
Type localVarReturnType = new TypeToken>(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getDeploymentsCount
* @param id Filter by deployment id (optional)
* @param name Filter by the deployment name. Exact match. (optional)
* @param nameLike Filter by the deployment name that the parameter is a substring of. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
* @param source Filter by the deployment source. (optional)
* @param withoutSource Filter by the deployment source whereby source is equal to `null`. (optional, default to false)
* @param tenantIdIn Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids. (optional)
* @param withoutTenantId Only include deployments which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param includeDeploymentsWithoutTenantId Include deployments which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param after Restricts to all deployments after the given date. By [default](https://docs.camunda.org/manual/latest/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
* @param before Restricts to all deployments before the given date. By [default](https://docs.camunda.org/manual/latest/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
400
Returned if some of the query parameters are invalid, for example, if an invalid operator for variable comparison is used. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call getDeploymentsCountCall(String id, String name, String nameLike, String source, Boolean withoutSource, String tenantIdIn, Boolean withoutTenantId, Boolean includeDeploymentsWithoutTenantId, Date after, Date before, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/deployment/count";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
if (id != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("id", id));
}
if (name != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("name", name));
}
if (nameLike != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("nameLike", nameLike));
}
if (source != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("source", source));
}
if (withoutSource != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("withoutSource", withoutSource));
}
if (tenantIdIn != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("tenantIdIn", tenantIdIn));
}
if (withoutTenantId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("withoutTenantId", withoutTenantId));
}
if (includeDeploymentsWithoutTenantId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("includeDeploymentsWithoutTenantId", includeDeploymentsWithoutTenantId));
}
if (after != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("after", after));
}
if (before != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("before", before));
}
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getDeploymentsCountValidateBeforeCall(String id, String name, String nameLike, String source, Boolean withoutSource, String tenantIdIn, Boolean withoutTenantId, Boolean includeDeploymentsWithoutTenantId, Date after, Date before, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getDeploymentsCountCall(id, name, nameLike, source, withoutSource, tenantIdIn, withoutTenantId, includeDeploymentsWithoutTenantId, after, before, _callback);
return localVarCall;
}
/**
*
* Queries for the number of deployments that fulfill given parameters. Takes the same parameters as the [Get Deployments](https://docs.camunda.org/manual/latest/reference/rest/deployment/get-query/) method.
* @param id Filter by deployment id (optional)
* @param name Filter by the deployment name. Exact match. (optional)
* @param nameLike Filter by the deployment name that the parameter is a substring of. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
* @param source Filter by the deployment source. (optional)
* @param withoutSource Filter by the deployment source whereby source is equal to `null`. (optional, default to false)
* @param tenantIdIn Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids. (optional)
* @param withoutTenantId Only include deployments which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param includeDeploymentsWithoutTenantId Include deployments which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param after Restricts to all deployments after the given date. By [default](https://docs.camunda.org/manual/latest/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
* @param before Restricts to all deployments before the given date. By [default](https://docs.camunda.org/manual/latest/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
* @return CountResultDto
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
400
Returned if some of the query parameters are invalid, for example, if an invalid operator for variable comparison is used. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public CountResultDto getDeploymentsCount(String id, String name, String nameLike, String source, Boolean withoutSource, String tenantIdIn, Boolean withoutTenantId, Boolean includeDeploymentsWithoutTenantId, Date after, Date before) throws ApiException {
ApiResponse localVarResp = getDeploymentsCountWithHttpInfo(id, name, nameLike, source, withoutSource, tenantIdIn, withoutTenantId, includeDeploymentsWithoutTenantId, after, before);
return localVarResp.getData();
}
/**
*
* Queries for the number of deployments that fulfill given parameters. Takes the same parameters as the [Get Deployments](https://docs.camunda.org/manual/latest/reference/rest/deployment/get-query/) method.
* @param id Filter by deployment id (optional)
* @param name Filter by the deployment name. Exact match. (optional)
* @param nameLike Filter by the deployment name that the parameter is a substring of. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
* @param source Filter by the deployment source. (optional)
* @param withoutSource Filter by the deployment source whereby source is equal to `null`. (optional, default to false)
* @param tenantIdIn Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids. (optional)
* @param withoutTenantId Only include deployments which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param includeDeploymentsWithoutTenantId Include deployments which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param after Restricts to all deployments after the given date. By [default](https://docs.camunda.org/manual/latest/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
* @param before Restricts to all deployments before the given date. By [default](https://docs.camunda.org/manual/latest/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
* @return ApiResponse<CountResultDto>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
400
Returned if some of the query parameters are invalid, for example, if an invalid operator for variable comparison is used. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public ApiResponse getDeploymentsCountWithHttpInfo(String id, String name, String nameLike, String source, Boolean withoutSource, String tenantIdIn, Boolean withoutTenantId, Boolean includeDeploymentsWithoutTenantId, Date after, Date before) throws ApiException {
okhttp3.Call localVarCall = getDeploymentsCountValidateBeforeCall(id, name, nameLike, source, withoutSource, tenantIdIn, withoutTenantId, includeDeploymentsWithoutTenantId, after, before, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* (asynchronously)
* Queries for the number of deployments that fulfill given parameters. Takes the same parameters as the [Get Deployments](https://docs.camunda.org/manual/latest/reference/rest/deployment/get-query/) method.
* @param id Filter by deployment id (optional)
* @param name Filter by the deployment name. Exact match. (optional)
* @param nameLike Filter by the deployment name that the parameter is a substring of. The parameter can include the wildcard `%` to express like-strategy such as: starts with (`%`name), ends with (name`%`) or contains (`%`name`%`). (optional)
* @param source Filter by the deployment source. (optional)
* @param withoutSource Filter by the deployment source whereby source is equal to `null`. (optional, default to false)
* @param tenantIdIn Filter by a comma-separated list of tenant ids. A deployment must have one of the given tenant ids. (optional)
* @param withoutTenantId Only include deployments which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param includeDeploymentsWithoutTenantId Include deployments which belong to no tenant. Can be used in combination with `tenantIdIn`. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param after Restricts to all deployments after the given date. By [default](https://docs.camunda.org/manual/latest/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
* @param before Restricts to all deployments before the given date. By [default](https://docs.camunda.org/manual/latest/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
400
Returned if some of the query parameters are invalid, for example, if an invalid operator for variable comparison is used. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call getDeploymentsCountAsync(String id, String name, String nameLike, String source, Boolean withoutSource, String tenantIdIn, Boolean withoutTenantId, Boolean includeDeploymentsWithoutTenantId, Date after, Date before, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getDeploymentsCountValidateBeforeCall(id, name, nameLike, source, withoutSource, tenantIdIn, withoutTenantId, includeDeploymentsWithoutTenantId, after, before, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for redeploy
* @param id The id of the deployment to re-deploy. (required)
* @param redeploymentDto (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
404
Deployment or a deployment resource for the given deployment does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call redeployCall(String id, RedeploymentDto redeploymentDto, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = redeploymentDto;
// create path and map variables
String localVarPath = "/deployment/{id}/redeploy"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { };
return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call redeployValidateBeforeCall(String id, RedeploymentDto redeploymentDto, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling redeploy(Async)");
}
okhttp3.Call localVarCall = redeployCall(id, redeploymentDto, _callback);
return localVarCall;
}
/**
*
* Re-deploys an existing deployment. The deployment resources to re-deploy can be restricted by using the properties `resourceIds` or `resourceNames`. If no deployment resources to re-deploy are passed then all existing resources of the given deployment are re-deployed. **Warning**: Deployments can contain custom code in form of scripts or EL expressions to customize process behavior. This may be abused for remote execution of arbitrary code. See the section on [security considerations for custom code](https://docs.camunda.org/manual/latest/user-guide/process-engine/securing-custom-code/) in the user guide for details.
* @param id The id of the deployment to re-deploy. (required)
* @param redeploymentDto (optional)
* @return DeploymentWithDefinitionsDto
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
404
Deployment or a deployment resource for the given deployment does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public DeploymentWithDefinitionsDto redeploy(String id, RedeploymentDto redeploymentDto) throws ApiException {
ApiResponse localVarResp = redeployWithHttpInfo(id, redeploymentDto);
return localVarResp.getData();
}
/**
*
* Re-deploys an existing deployment. The deployment resources to re-deploy can be restricted by using the properties `resourceIds` or `resourceNames`. If no deployment resources to re-deploy are passed then all existing resources of the given deployment are re-deployed. **Warning**: Deployments can contain custom code in form of scripts or EL expressions to customize process behavior. This may be abused for remote execution of arbitrary code. See the section on [security considerations for custom code](https://docs.camunda.org/manual/latest/user-guide/process-engine/securing-custom-code/) in the user guide for details.
* @param id The id of the deployment to re-deploy. (required)
* @param redeploymentDto (optional)
* @return ApiResponse<DeploymentWithDefinitionsDto>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
404
Deployment or a deployment resource for the given deployment does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public ApiResponse redeployWithHttpInfo(String id, RedeploymentDto redeploymentDto) throws ApiException {
okhttp3.Call localVarCall = redeployValidateBeforeCall(id, redeploymentDto, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* (asynchronously)
* Re-deploys an existing deployment. The deployment resources to re-deploy can be restricted by using the properties `resourceIds` or `resourceNames`. If no deployment resources to re-deploy are passed then all existing resources of the given deployment are re-deployed. **Warning**: Deployments can contain custom code in form of scripts or EL expressions to customize process behavior. This may be abused for remote execution of arbitrary code. See the section on [security considerations for custom code](https://docs.camunda.org/manual/latest/user-guide/process-engine/securing-custom-code/) in the user guide for details.
* @param id The id of the deployment to re-deploy. (required)
* @param redeploymentDto (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
404
Deployment or a deployment resource for the given deployment does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call redeployAsync(String id, RedeploymentDto redeploymentDto, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = redeployValidateBeforeCall(id, redeploymentDto, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
}
