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.
software.tnb.jira.validation.generated.api.IssueFieldConfigurationsApi Maven / Gradle / Ivy
/*
* The Jira Cloud platform REST API
* Jira Cloud platform REST API documentation
*
* The version of the OpenAPI document: 1001.0.0-SNAPSHOT
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package software.tnb.jira.validation.generated.api;
import software.tnb.jira.validation.generated.ApiCallback;
import software.tnb.jira.validation.generated.ApiClient;
import software.tnb.jira.validation.generated.ApiException;
import software.tnb.jira.validation.generated.ApiResponse;
import software.tnb.jira.validation.generated.Configuration;
import software.tnb.jira.validation.generated.Pair;
import software.tnb.jira.validation.generated.ProgressRequestBody;
import software.tnb.jira.validation.generated.ProgressResponseBody;
import com.google.gson.reflect.TypeToken;
import java.io.IOException;
import software.tnb.jira.validation.generated.model.AssociateFieldConfigurationsWithIssueTypesRequest;
import software.tnb.jira.validation.generated.model.ErrorCollection;
import software.tnb.jira.validation.generated.model.FieldConfiguration;
import software.tnb.jira.validation.generated.model.FieldConfigurationDetails;
import software.tnb.jira.validation.generated.model.FieldConfigurationItemsDetails;
import software.tnb.jira.validation.generated.model.FieldConfigurationScheme;
import software.tnb.jira.validation.generated.model.FieldConfigurationSchemeProjectAssociation;
import software.tnb.jira.validation.generated.model.IssueTypeIdsToRemove;
import software.tnb.jira.validation.generated.model.PageBeanFieldConfigurationDetails;
import software.tnb.jira.validation.generated.model.PageBeanFieldConfigurationIssueTypeItem;
import software.tnb.jira.validation.generated.model.PageBeanFieldConfigurationItem;
import software.tnb.jira.validation.generated.model.PageBeanFieldConfigurationScheme;
import software.tnb.jira.validation.generated.model.PageBeanFieldConfigurationSchemeProjects;
import java.util.Set;
import software.tnb.jira.validation.generated.model.UpdateFieldConfigurationSchemeDetails;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import jakarta.ws.rs.core.GenericType;
public class IssueFieldConfigurationsApi {
private ApiClient localVarApiClient;
private int localHostIndex;
private String localCustomBaseUrl;
public IssueFieldConfigurationsApi() {
this(Configuration.getDefaultApiClient());
}
public IssueFieldConfigurationsApi(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
public ApiClient getApiClient() {
return localVarApiClient;
}
public void setApiClient(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
public int getHostIndex() {
return localHostIndex;
}
public void setHostIndex(int hostIndex) {
this.localHostIndex = hostIndex;
}
public String getCustomBaseUrl() {
return localCustomBaseUrl;
}
public void setCustomBaseUrl(String customBaseUrl) {
this.localCustomBaseUrl = customBaseUrl;
}
/**
* Build call for assignFieldConfigurationSchemeToProject
* @param fieldConfigurationSchemeProjectAssociation (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 204 Returned if the request is successful. - 400 Returned if the project is not a classic project. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permissions. - 404 Returned if the project is missing. -
*/
public okhttp3.Call assignFieldConfigurationSchemeToProjectCall(FieldConfigurationSchemeProjectAssociation fieldConfigurationSchemeProjectAssociation, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = fieldConfigurationSchemeProjectAssociation;
// create path and map variables
String localVarPath = "/rest/api/3/fieldconfigurationscheme/project";
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);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "OAuth2", "basicAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call assignFieldConfigurationSchemeToProjectValidateBeforeCall(FieldConfigurationSchemeProjectAssociation fieldConfigurationSchemeProjectAssociation, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'fieldConfigurationSchemeProjectAssociation' is set
if (fieldConfigurationSchemeProjectAssociation == null) {
throw new ApiException("Missing the required parameter 'fieldConfigurationSchemeProjectAssociation' when calling assignFieldConfigurationSchemeToProject(Async)");
}
return assignFieldConfigurationSchemeToProjectCall(fieldConfigurationSchemeProjectAssociation, _callback);
}
/**
* Assign field configuration scheme to project
* Assigns a field configuration scheme to a project. If the field configuration scheme ID is `null`, the operation assigns the default field configuration scheme. Field configuration schemes can only be assigned to classic projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param fieldConfigurationSchemeProjectAssociation (required)
* @return Object
* @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 Returned if the request is successful. - 400 Returned if the project is not a classic project. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permissions. - 404 Returned if the project is missing. -
*/
public Object assignFieldConfigurationSchemeToProject(FieldConfigurationSchemeProjectAssociation fieldConfigurationSchemeProjectAssociation) throws ApiException {
ApiResponse localVarResp = assignFieldConfigurationSchemeToProjectWithHttpInfo(fieldConfigurationSchemeProjectAssociation);
return localVarResp.getData();
}
/**
* Assign field configuration scheme to project
* Assigns a field configuration scheme to a project. If the field configuration scheme ID is `null`, the operation assigns the default field configuration scheme. Field configuration schemes can only be assigned to classic projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param fieldConfigurationSchemeProjectAssociation (required)
* @return ApiResponse<Object>
* @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 Returned if the request is successful. - 400 Returned if the project is not a classic project. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permissions. - 404 Returned if the project is missing. -
*/
public ApiResponse assignFieldConfigurationSchemeToProjectWithHttpInfo(FieldConfigurationSchemeProjectAssociation fieldConfigurationSchemeProjectAssociation) throws ApiException {
okhttp3.Call localVarCall = assignFieldConfigurationSchemeToProjectValidateBeforeCall(fieldConfigurationSchemeProjectAssociation, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Assign field configuration scheme to project (asynchronously)
* Assigns a field configuration scheme to a project. If the field configuration scheme ID is `null`, the operation assigns the default field configuration scheme. Field configuration schemes can only be assigned to classic projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param fieldConfigurationSchemeProjectAssociation (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 204 Returned if the request is successful. - 400 Returned if the project is not a classic project. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permissions. - 404 Returned if the project is missing. -
*/
public okhttp3.Call assignFieldConfigurationSchemeToProjectAsync(FieldConfigurationSchemeProjectAssociation fieldConfigurationSchemeProjectAssociation, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = assignFieldConfigurationSchemeToProjectValidateBeforeCall(fieldConfigurationSchemeProjectAssociation, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for createFieldConfiguration
* @param fieldConfigurationDetails (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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. -
*/
public okhttp3.Call createFieldConfigurationCall(FieldConfigurationDetails fieldConfigurationDetails, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = fieldConfigurationDetails;
// create path and map variables
String localVarPath = "/rest/api/3/fieldconfiguration";
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);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "OAuth2", "basicAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call createFieldConfigurationValidateBeforeCall(FieldConfigurationDetails fieldConfigurationDetails, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'fieldConfigurationDetails' is set
if (fieldConfigurationDetails == null) {
throw new ApiException("Missing the required parameter 'fieldConfigurationDetails' when calling createFieldConfiguration(Async)");
}
return createFieldConfigurationCall(fieldConfigurationDetails, _callback);
}
/**
* Create field configuration
* Creates a field configuration. The field configuration is created with the same field properties as the default configuration, with all the fields being optional. This operation can only create configurations for use in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param fieldConfigurationDetails (required)
* @return FieldConfiguration
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. -
*/
public FieldConfiguration createFieldConfiguration(FieldConfigurationDetails fieldConfigurationDetails) throws ApiException {
ApiResponse localVarResp = createFieldConfigurationWithHttpInfo(fieldConfigurationDetails);
return localVarResp.getData();
}
/**
* Create field configuration
* Creates a field configuration. The field configuration is created with the same field properties as the default configuration, with all the fields being optional. This operation can only create configurations for use in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param fieldConfigurationDetails (required)
* @return ApiResponse<FieldConfiguration>
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. -
*/
public ApiResponse createFieldConfigurationWithHttpInfo(FieldConfigurationDetails fieldConfigurationDetails) throws ApiException {
okhttp3.Call localVarCall = createFieldConfigurationValidateBeforeCall(fieldConfigurationDetails, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Create field configuration (asynchronously)
* Creates a field configuration. The field configuration is created with the same field properties as the default configuration, with all the fields being optional. This operation can only create configurations for use in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param fieldConfigurationDetails (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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. -
*/
public okhttp3.Call createFieldConfigurationAsync(FieldConfigurationDetails fieldConfigurationDetails, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = createFieldConfigurationValidateBeforeCall(fieldConfigurationDetails, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for createFieldConfigurationScheme
* @param updateFieldConfigurationSchemeDetails The details of the field configuration scheme. (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 201 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permissions. -
*/
public okhttp3.Call createFieldConfigurationSchemeCall(UpdateFieldConfigurationSchemeDetails updateFieldConfigurationSchemeDetails, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = updateFieldConfigurationSchemeDetails;
// create path and map variables
String localVarPath = "/rest/api/3/fieldconfigurationscheme";
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);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "OAuth2", "basicAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call createFieldConfigurationSchemeValidateBeforeCall(UpdateFieldConfigurationSchemeDetails updateFieldConfigurationSchemeDetails, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'updateFieldConfigurationSchemeDetails' is set
if (updateFieldConfigurationSchemeDetails == null) {
throw new ApiException("Missing the required parameter 'updateFieldConfigurationSchemeDetails' when calling createFieldConfigurationScheme(Async)");
}
return createFieldConfigurationSchemeCall(updateFieldConfigurationSchemeDetails, _callback);
}
/**
* Create field configuration scheme
* Creates a field configuration scheme. This operation can only create field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param updateFieldConfigurationSchemeDetails The details of the field configuration scheme. (required)
* @return FieldConfigurationScheme
* @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 201 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permissions. -
*/
public FieldConfigurationScheme createFieldConfigurationScheme(UpdateFieldConfigurationSchemeDetails updateFieldConfigurationSchemeDetails) throws ApiException {
ApiResponse localVarResp = createFieldConfigurationSchemeWithHttpInfo(updateFieldConfigurationSchemeDetails);
return localVarResp.getData();
}
/**
* Create field configuration scheme
* Creates a field configuration scheme. This operation can only create field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param updateFieldConfigurationSchemeDetails The details of the field configuration scheme. (required)
* @return ApiResponse<FieldConfigurationScheme>
* @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 201 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permissions. -
*/
public ApiResponse createFieldConfigurationSchemeWithHttpInfo(UpdateFieldConfigurationSchemeDetails updateFieldConfigurationSchemeDetails) throws ApiException {
okhttp3.Call localVarCall = createFieldConfigurationSchemeValidateBeforeCall(updateFieldConfigurationSchemeDetails, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Create field configuration scheme (asynchronously)
* Creates a field configuration scheme. This operation can only create field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param updateFieldConfigurationSchemeDetails The details of the field configuration scheme. (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 201 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permissions. -
*/
public okhttp3.Call createFieldConfigurationSchemeAsync(UpdateFieldConfigurationSchemeDetails updateFieldConfigurationSchemeDetails, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = createFieldConfigurationSchemeValidateBeforeCall(updateFieldConfigurationSchemeDetails, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for deleteFieldConfiguration
* @param id The ID of the field configuration. (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 204 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration is not found. -
*/
public okhttp3.Call deleteFieldConfigurationCall(Long id, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/rest/api/3/fieldconfiguration/{id}"
.replace("{" + "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);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "OAuth2", "basicAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call deleteFieldConfigurationValidateBeforeCall(Long 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 deleteFieldConfiguration(Async)");
}
return deleteFieldConfigurationCall(id, _callback);
}
/**
* Delete field configuration
* Deletes a field configuration. This operation can only delete configurations used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration. (required)
* @return Object
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration is not found. -
*/
public Object deleteFieldConfiguration(Long id) throws ApiException {
ApiResponse localVarResp = deleteFieldConfigurationWithHttpInfo(id);
return localVarResp.getData();
}
/**
* Delete field configuration
* Deletes a field configuration. This operation can only delete configurations used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration. (required)
* @return ApiResponse<Object>
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration is not found. -
*/
public ApiResponse deleteFieldConfigurationWithHttpInfo(Long id) throws ApiException {
okhttp3.Call localVarCall = deleteFieldConfigurationValidateBeforeCall(id, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Delete field configuration (asynchronously)
* Deletes a field configuration. This operation can only delete configurations used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration. (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 204 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration is not found. -
*/
public okhttp3.Call deleteFieldConfigurationAsync(Long id, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = deleteFieldConfigurationValidateBeforeCall(id, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for deleteFieldConfigurationScheme
* @param id The ID of the field configuration scheme. (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 204 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration scheme is not found. -
*/
public okhttp3.Call deleteFieldConfigurationSchemeCall(Long id, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/rest/api/3/fieldconfigurationscheme/{id}"
.replace("{" + "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);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "OAuth2", "basicAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call deleteFieldConfigurationSchemeValidateBeforeCall(Long 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 deleteFieldConfigurationScheme(Async)");
}
return deleteFieldConfigurationSchemeCall(id, _callback);
}
/**
* Delete field configuration scheme
* Deletes a field configuration scheme. This operation can only delete field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration scheme. (required)
* @return Object
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration scheme is not found. -
*/
public Object deleteFieldConfigurationScheme(Long id) throws ApiException {
ApiResponse localVarResp = deleteFieldConfigurationSchemeWithHttpInfo(id);
return localVarResp.getData();
}
/**
* Delete field configuration scheme
* Deletes a field configuration scheme. This operation can only delete field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration scheme. (required)
* @return ApiResponse<Object>
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration scheme is not found. -
*/
public ApiResponse deleteFieldConfigurationSchemeWithHttpInfo(Long id) throws ApiException {
okhttp3.Call localVarCall = deleteFieldConfigurationSchemeValidateBeforeCall(id, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Delete field configuration scheme (asynchronously)
* Deletes a field configuration scheme. This operation can only delete field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration scheme. (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 204 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration scheme is not found. -
*/
public okhttp3.Call deleteFieldConfigurationSchemeAsync(Long id, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = deleteFieldConfigurationSchemeValidateBeforeCall(id, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getAllFieldConfigurationSchemes
* @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
* @param maxResults The maximum number of items to return per page. (optional, default to 50)
* @param id The list of field configuration scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. (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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permissions. -
*/
public okhttp3.Call getAllFieldConfigurationSchemesCall(Long startAt, Integer maxResults, Set id, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/rest/api/3/fieldconfigurationscheme";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (startAt != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("startAt", startAt));
}
if (maxResults != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("maxResults", maxResults));
}
if (id != null) {
localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "id", id));
}
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);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "OAuth2", "basicAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getAllFieldConfigurationSchemesValidateBeforeCall(Long startAt, Integer maxResults, Set id, final ApiCallback _callback) throws ApiException {
return getAllFieldConfigurationSchemesCall(startAt, maxResults, id, _callback);
}
/**
* Get all field configuration schemes
* Returns a [paginated](#pagination) list of field configuration schemes. Only field configuration schemes used in classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
* @param maxResults The maximum number of items to return per page. (optional, default to 50)
* @param id The list of field configuration scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. (optional)
* @return PageBeanFieldConfigurationScheme
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permissions. -
*/
public PageBeanFieldConfigurationScheme getAllFieldConfigurationSchemes(Long startAt, Integer maxResults, Set id) throws ApiException {
ApiResponse localVarResp = getAllFieldConfigurationSchemesWithHttpInfo(startAt, maxResults, id);
return localVarResp.getData();
}
/**
* Get all field configuration schemes
* Returns a [paginated](#pagination) list of field configuration schemes. Only field configuration schemes used in classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
* @param maxResults The maximum number of items to return per page. (optional, default to 50)
* @param id The list of field configuration scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. (optional)
* @return ApiResponse<PageBeanFieldConfigurationScheme>
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permissions. -
*/
public ApiResponse getAllFieldConfigurationSchemesWithHttpInfo(Long startAt, Integer maxResults, Set id) throws ApiException {
okhttp3.Call localVarCall = getAllFieldConfigurationSchemesValidateBeforeCall(startAt, maxResults, id, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Get all field configuration schemes (asynchronously)
* Returns a [paginated](#pagination) list of field configuration schemes. Only field configuration schemes used in classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
* @param maxResults The maximum number of items to return per page. (optional, default to 50)
* @param id The list of field configuration scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. (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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permissions. -
*/
public okhttp3.Call getAllFieldConfigurationSchemesAsync(Long startAt, Integer maxResults, Set id, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getAllFieldConfigurationSchemesValidateBeforeCall(startAt, maxResults, id, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getAllFieldConfigurations
* @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
* @param maxResults The maximum number of items to return per page. (optional, default to 50)
* @param id The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. (optional)
* @param isDefault If *true* returns default field configurations only. (optional, default to false)
* @param query The query string used to match against field configuration names and descriptions. (optional, default to )
* @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 Returned if the request is successful. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. -
*/
public okhttp3.Call getAllFieldConfigurationsCall(Long startAt, Integer maxResults, Set id, Boolean isDefault, String query, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/rest/api/3/fieldconfiguration";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (startAt != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("startAt", startAt));
}
if (maxResults != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("maxResults", maxResults));
}
if (id != null) {
localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "id", id));
}
if (isDefault != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("isDefault", isDefault));
}
if (query != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("query", query));
}
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);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "OAuth2", "basicAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getAllFieldConfigurationsValidateBeforeCall(Long startAt, Integer maxResults, Set id, Boolean isDefault, String query, final ApiCallback _callback) throws ApiException {
return getAllFieldConfigurationsCall(startAt, maxResults, id, isDefault, query, _callback);
}
/**
* Get all field configurations
* Returns a [paginated](#pagination) list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria: * a list of field configuration item IDs. * whether the field configuration is a default. * whether the field configuration name or description contains a query string. Only field configurations used in company-managed (classic) projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
* @param maxResults The maximum number of items to return per page. (optional, default to 50)
* @param id The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. (optional)
* @param isDefault If *true* returns default field configurations only. (optional, default to false)
* @param query The query string used to match against field configuration names and descriptions. (optional, default to )
* @return PageBeanFieldConfigurationDetails
* @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 Returned if the request is successful. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. -
*/
public PageBeanFieldConfigurationDetails getAllFieldConfigurations(Long startAt, Integer maxResults, Set id, Boolean isDefault, String query) throws ApiException {
ApiResponse localVarResp = getAllFieldConfigurationsWithHttpInfo(startAt, maxResults, id, isDefault, query);
return localVarResp.getData();
}
/**
* Get all field configurations
* Returns a [paginated](#pagination) list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria: * a list of field configuration item IDs. * whether the field configuration is a default. * whether the field configuration name or description contains a query string. Only field configurations used in company-managed (classic) projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
* @param maxResults The maximum number of items to return per page. (optional, default to 50)
* @param id The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. (optional)
* @param isDefault If *true* returns default field configurations only. (optional, default to false)
* @param query The query string used to match against field configuration names and descriptions. (optional, default to )
* @return ApiResponse<PageBeanFieldConfigurationDetails>
* @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 Returned if the request is successful. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. -
*/
public ApiResponse getAllFieldConfigurationsWithHttpInfo(Long startAt, Integer maxResults, Set id, Boolean isDefault, String query) throws ApiException {
okhttp3.Call localVarCall = getAllFieldConfigurationsValidateBeforeCall(startAt, maxResults, id, isDefault, query, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Get all field configurations (asynchronously)
* Returns a [paginated](#pagination) list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria: * a list of field configuration item IDs. * whether the field configuration is a default. * whether the field configuration name or description contains a query string. Only field configurations used in company-managed (classic) projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
* @param maxResults The maximum number of items to return per page. (optional, default to 50)
* @param id The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. (optional)
* @param isDefault If *true* returns default field configurations only. (optional, default to false)
* @param query The query string used to match against field configuration names and descriptions. (optional, default to )
* @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 Returned if the request is successful. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. -
*/
public okhttp3.Call getAllFieldConfigurationsAsync(Long startAt, Integer maxResults, Set id, Boolean isDefault, String query, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getAllFieldConfigurationsValidateBeforeCall(startAt, maxResults, id, isDefault, query, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getFieldConfigurationItems
* @param id The ID of the field configuration. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
* @param maxResults The maximum number of items to return per page. (optional, default to 50)
* @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 Returned if the request is successful. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration is not found. -
*/
public okhttp3.Call getFieldConfigurationItemsCall(Long id, Long startAt, Integer maxResults, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/rest/api/3/fieldconfiguration/{id}/fields"
.replace("{" + "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();
if (startAt != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("startAt", startAt));
}
if (maxResults != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("maxResults", maxResults));
}
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);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "OAuth2", "basicAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getFieldConfigurationItemsValidateBeforeCall(Long id, Long startAt, Integer maxResults, 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 getFieldConfigurationItems(Async)");
}
return getFieldConfigurationItemsCall(id, startAt, maxResults, _callback);
}
/**
* Get field configuration items
* Returns a [paginated](#pagination) list of all fields for a configuration. Only the fields from configurations used in company-managed (classic) projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
* @param maxResults The maximum number of items to return per page. (optional, default to 50)
* @return PageBeanFieldConfigurationItem
* @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 Returned if the request is successful. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration is not found. -
*/
public PageBeanFieldConfigurationItem getFieldConfigurationItems(Long id, Long startAt, Integer maxResults) throws ApiException {
ApiResponse localVarResp = getFieldConfigurationItemsWithHttpInfo(id, startAt, maxResults);
return localVarResp.getData();
}
/**
* Get field configuration items
* Returns a [paginated](#pagination) list of all fields for a configuration. Only the fields from configurations used in company-managed (classic) projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
* @param maxResults The maximum number of items to return per page. (optional, default to 50)
* @return ApiResponse<PageBeanFieldConfigurationItem>
* @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 Returned if the request is successful. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration is not found. -
*/
public ApiResponse getFieldConfigurationItemsWithHttpInfo(Long id, Long startAt, Integer maxResults) throws ApiException {
okhttp3.Call localVarCall = getFieldConfigurationItemsValidateBeforeCall(id, startAt, maxResults, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Get field configuration items (asynchronously)
* Returns a [paginated](#pagination) list of all fields for a configuration. Only the fields from configurations used in company-managed (classic) projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
* @param maxResults The maximum number of items to return per page. (optional, default to 50)
* @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 Returned if the request is successful. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration is not found. -
*/
public okhttp3.Call getFieldConfigurationItemsAsync(Long id, Long startAt, Integer maxResults, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getFieldConfigurationItemsValidateBeforeCall(id, startAt, maxResults, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getFieldConfigurationSchemeMappings
* @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
* @param maxResults The maximum number of items to return per page. (optional, default to 50)
* @param fieldConfigurationSchemeId The list of field configuration scheme IDs. To include multiple field configuration schemes separate IDs with ampersand: `fieldConfigurationSchemeId=10000&fieldConfigurationSchemeId=10001`. (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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if no field configuration schemes are found. -
*/
public okhttp3.Call getFieldConfigurationSchemeMappingsCall(Long startAt, Integer maxResults, Set fieldConfigurationSchemeId, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/rest/api/3/fieldconfigurationscheme/mapping";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (startAt != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("startAt", startAt));
}
if (maxResults != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("maxResults", maxResults));
}
if (fieldConfigurationSchemeId != null) {
localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "fieldConfigurationSchemeId", fieldConfigurationSchemeId));
}
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);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "OAuth2", "basicAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getFieldConfigurationSchemeMappingsValidateBeforeCall(Long startAt, Integer maxResults, Set fieldConfigurationSchemeId, final ApiCallback _callback) throws ApiException {
return getFieldConfigurationSchemeMappingsCall(startAt, maxResults, fieldConfigurationSchemeId, _callback);
}
/**
* Get field configuration issue type items
* Returns a [paginated](#pagination) list of field configuration issue type items. Only items used in classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
* @param maxResults The maximum number of items to return per page. (optional, default to 50)
* @param fieldConfigurationSchemeId The list of field configuration scheme IDs. To include multiple field configuration schemes separate IDs with ampersand: `fieldConfigurationSchemeId=10000&fieldConfigurationSchemeId=10001`. (optional)
* @return PageBeanFieldConfigurationIssueTypeItem
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if no field configuration schemes are found. -
*/
public PageBeanFieldConfigurationIssueTypeItem getFieldConfigurationSchemeMappings(Long startAt, Integer maxResults, Set fieldConfigurationSchemeId) throws ApiException {
ApiResponse localVarResp = getFieldConfigurationSchemeMappingsWithHttpInfo(startAt, maxResults, fieldConfigurationSchemeId);
return localVarResp.getData();
}
/**
* Get field configuration issue type items
* Returns a [paginated](#pagination) list of field configuration issue type items. Only items used in classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
* @param maxResults The maximum number of items to return per page. (optional, default to 50)
* @param fieldConfigurationSchemeId The list of field configuration scheme IDs. To include multiple field configuration schemes separate IDs with ampersand: `fieldConfigurationSchemeId=10000&fieldConfigurationSchemeId=10001`. (optional)
* @return ApiResponse<PageBeanFieldConfigurationIssueTypeItem>
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if no field configuration schemes are found. -
*/
public ApiResponse getFieldConfigurationSchemeMappingsWithHttpInfo(Long startAt, Integer maxResults, Set fieldConfigurationSchemeId) throws ApiException {
okhttp3.Call localVarCall = getFieldConfigurationSchemeMappingsValidateBeforeCall(startAt, maxResults, fieldConfigurationSchemeId, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Get field configuration issue type items (asynchronously)
* Returns a [paginated](#pagination) list of field configuration issue type items. Only items used in classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
* @param maxResults The maximum number of items to return per page. (optional, default to 50)
* @param fieldConfigurationSchemeId The list of field configuration scheme IDs. To include multiple field configuration schemes separate IDs with ampersand: `fieldConfigurationSchemeId=10000&fieldConfigurationSchemeId=10001`. (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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if no field configuration schemes are found. -
*/
public okhttp3.Call getFieldConfigurationSchemeMappingsAsync(Long startAt, Integer maxResults, Set fieldConfigurationSchemeId, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getFieldConfigurationSchemeMappingsValidateBeforeCall(startAt, maxResults, fieldConfigurationSchemeId, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getFieldConfigurationSchemeProjectMapping
* @param projectId The list of project IDs. To include multiple projects, separate IDs with ampersand: `projectId=10000&projectId=10001`. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
* @param maxResults The maximum number of items to return per page. (optional, default to 50)
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. -
*/
public okhttp3.Call getFieldConfigurationSchemeProjectMappingCall(Set projectId, Long startAt, Integer maxResults, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/rest/api/3/fieldconfigurationscheme/project";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (startAt != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("startAt", startAt));
}
if (maxResults != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("maxResults", maxResults));
}
if (projectId != null) {
localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "projectId", projectId));
}
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);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "OAuth2", "basicAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getFieldConfigurationSchemeProjectMappingValidateBeforeCall(Set projectId, Long startAt, Integer maxResults, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'projectId' is set
if (projectId == null) {
throw new ApiException("Missing the required parameter 'projectId' when calling getFieldConfigurationSchemeProjectMapping(Async)");
}
return getFieldConfigurationSchemeProjectMappingCall(projectId, startAt, maxResults, _callback);
}
/**
* Get field configuration schemes for projects
* Returns a [paginated](#pagination) list of field configuration schemes and, for each scheme, a list of the projects that use it. The list is sorted by field configuration scheme ID. The first item contains the list of project IDs assigned to the default field configuration scheme. Only field configuration schemes used in classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param projectId The list of project IDs. To include multiple projects, separate IDs with ampersand: `projectId=10000&projectId=10001`. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
* @param maxResults The maximum number of items to return per page. (optional, default to 50)
* @return PageBeanFieldConfigurationSchemeProjects
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. -
*/
public PageBeanFieldConfigurationSchemeProjects getFieldConfigurationSchemeProjectMapping(Set projectId, Long startAt, Integer maxResults) throws ApiException {
ApiResponse localVarResp = getFieldConfigurationSchemeProjectMappingWithHttpInfo(projectId, startAt, maxResults);
return localVarResp.getData();
}
/**
* Get field configuration schemes for projects
* Returns a [paginated](#pagination) list of field configuration schemes and, for each scheme, a list of the projects that use it. The list is sorted by field configuration scheme ID. The first item contains the list of project IDs assigned to the default field configuration scheme. Only field configuration schemes used in classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param projectId The list of project IDs. To include multiple projects, separate IDs with ampersand: `projectId=10000&projectId=10001`. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
* @param maxResults The maximum number of items to return per page. (optional, default to 50)
* @return ApiResponse<PageBeanFieldConfigurationSchemeProjects>
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. -
*/
public ApiResponse getFieldConfigurationSchemeProjectMappingWithHttpInfo(Set projectId, Long startAt, Integer maxResults) throws ApiException {
okhttp3.Call localVarCall = getFieldConfigurationSchemeProjectMappingValidateBeforeCall(projectId, startAt, maxResults, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Get field configuration schemes for projects (asynchronously)
* Returns a [paginated](#pagination) list of field configuration schemes and, for each scheme, a list of the projects that use it. The list is sorted by field configuration scheme ID. The first item contains the list of project IDs assigned to the default field configuration scheme. Only field configuration schemes used in classic projects are returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param projectId The list of project IDs. To include multiple projects, separate IDs with ampersand: `projectId=10000&projectId=10001`. (required)
* @param startAt The index of the first item to return in a page of results (page offset). (optional, default to 0)
* @param maxResults The maximum number of items to return per page. (optional, default to 50)
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. -
*/
public okhttp3.Call getFieldConfigurationSchemeProjectMappingAsync(Set projectId, Long startAt, Integer maxResults, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getFieldConfigurationSchemeProjectMappingValidateBeforeCall(projectId, startAt, maxResults, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for removeIssueTypesFromGlobalFieldConfigurationScheme
* @param id The ID of the field configuration scheme. (required)
* @param issueTypeIdsToRemove The issue type IDs to remove. (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 204 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration scheme or the issue types are not found. -
*/
public okhttp3.Call removeIssueTypesFromGlobalFieldConfigurationSchemeCall(Long id, IssueTypeIdsToRemove issueTypeIdsToRemove, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = issueTypeIdsToRemove;
// create path and map variables
String localVarPath = "/rest/api/3/fieldconfigurationscheme/{id}/mapping/delete"
.replace("{" + "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);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "OAuth2", "basicAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call removeIssueTypesFromGlobalFieldConfigurationSchemeValidateBeforeCall(Long id, IssueTypeIdsToRemove issueTypeIdsToRemove, 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 removeIssueTypesFromGlobalFieldConfigurationScheme(Async)");
}
// verify the required parameter 'issueTypeIdsToRemove' is set
if (issueTypeIdsToRemove == null) {
throw new ApiException("Missing the required parameter 'issueTypeIdsToRemove' when calling removeIssueTypesFromGlobalFieldConfigurationScheme(Async)");
}
return removeIssueTypesFromGlobalFieldConfigurationSchemeCall(id, issueTypeIdsToRemove, _callback);
}
/**
* Remove issue types from field configuration scheme
* Removes issue types from the field configuration scheme. This operation can only modify field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration scheme. (required)
* @param issueTypeIdsToRemove The issue type IDs to remove. (required)
* @return Object
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration scheme or the issue types are not found. -
*/
public Object removeIssueTypesFromGlobalFieldConfigurationScheme(Long id, IssueTypeIdsToRemove issueTypeIdsToRemove) throws ApiException {
ApiResponse localVarResp = removeIssueTypesFromGlobalFieldConfigurationSchemeWithHttpInfo(id, issueTypeIdsToRemove);
return localVarResp.getData();
}
/**
* Remove issue types from field configuration scheme
* Removes issue types from the field configuration scheme. This operation can only modify field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration scheme. (required)
* @param issueTypeIdsToRemove The issue type IDs to remove. (required)
* @return ApiResponse<Object>
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration scheme or the issue types are not found. -
*/
public ApiResponse removeIssueTypesFromGlobalFieldConfigurationSchemeWithHttpInfo(Long id, IssueTypeIdsToRemove issueTypeIdsToRemove) throws ApiException {
okhttp3.Call localVarCall = removeIssueTypesFromGlobalFieldConfigurationSchemeValidateBeforeCall(id, issueTypeIdsToRemove, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Remove issue types from field configuration scheme (asynchronously)
* Removes issue types from the field configuration scheme. This operation can only modify field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration scheme. (required)
* @param issueTypeIdsToRemove The issue type IDs to remove. (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 204 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration scheme or the issue types are not found. -
*/
public okhttp3.Call removeIssueTypesFromGlobalFieldConfigurationSchemeAsync(Long id, IssueTypeIdsToRemove issueTypeIdsToRemove, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = removeIssueTypesFromGlobalFieldConfigurationSchemeValidateBeforeCall(id, issueTypeIdsToRemove, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for setFieldConfigurationSchemeMapping
* @param id The ID of the field configuration scheme. (required)
* @param associateFieldConfigurationsWithIssueTypesRequest (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 204 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration scheme, the field configuration, or the issue type is not found. -
*/
public okhttp3.Call setFieldConfigurationSchemeMappingCall(Long id, AssociateFieldConfigurationsWithIssueTypesRequest associateFieldConfigurationsWithIssueTypesRequest, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = associateFieldConfigurationsWithIssueTypesRequest;
// create path and map variables
String localVarPath = "/rest/api/3/fieldconfigurationscheme/{id}/mapping"
.replace("{" + "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);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "OAuth2", "basicAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call setFieldConfigurationSchemeMappingValidateBeforeCall(Long id, AssociateFieldConfigurationsWithIssueTypesRequest associateFieldConfigurationsWithIssueTypesRequest, 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 setFieldConfigurationSchemeMapping(Async)");
}
// verify the required parameter 'associateFieldConfigurationsWithIssueTypesRequest' is set
if (associateFieldConfigurationsWithIssueTypesRequest == null) {
throw new ApiException("Missing the required parameter 'associateFieldConfigurationsWithIssueTypesRequest' when calling setFieldConfigurationSchemeMapping(Async)");
}
return setFieldConfigurationSchemeMappingCall(id, associateFieldConfigurationsWithIssueTypesRequest, _callback);
}
/**
* Assign issue types to field configurations
* Assigns issue types to field configurations on field configuration scheme. This operation can only modify field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration scheme. (required)
* @param associateFieldConfigurationsWithIssueTypesRequest (required)
* @return Object
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration scheme, the field configuration, or the issue type is not found. -
*/
public Object setFieldConfigurationSchemeMapping(Long id, AssociateFieldConfigurationsWithIssueTypesRequest associateFieldConfigurationsWithIssueTypesRequest) throws ApiException {
ApiResponse localVarResp = setFieldConfigurationSchemeMappingWithHttpInfo(id, associateFieldConfigurationsWithIssueTypesRequest);
return localVarResp.getData();
}
/**
* Assign issue types to field configurations
* Assigns issue types to field configurations on field configuration scheme. This operation can only modify field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration scheme. (required)
* @param associateFieldConfigurationsWithIssueTypesRequest (required)
* @return ApiResponse<Object>
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration scheme, the field configuration, or the issue type is not found. -
*/
public ApiResponse setFieldConfigurationSchemeMappingWithHttpInfo(Long id, AssociateFieldConfigurationsWithIssueTypesRequest associateFieldConfigurationsWithIssueTypesRequest) throws ApiException {
okhttp3.Call localVarCall = setFieldConfigurationSchemeMappingValidateBeforeCall(id, associateFieldConfigurationsWithIssueTypesRequest, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Assign issue types to field configurations (asynchronously)
* Assigns issue types to field configurations on field configuration scheme. This operation can only modify field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration scheme. (required)
* @param associateFieldConfigurationsWithIssueTypesRequest (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 204 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration scheme, the field configuration, or the issue type is not found. -
*/
public okhttp3.Call setFieldConfigurationSchemeMappingAsync(Long id, AssociateFieldConfigurationsWithIssueTypesRequest associateFieldConfigurationsWithIssueTypesRequest, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = setFieldConfigurationSchemeMappingValidateBeforeCall(id, associateFieldConfigurationsWithIssueTypesRequest, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for updateFieldConfiguration
* @param id The ID of the field configuration. (required)
* @param fieldConfigurationDetails (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 204 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration is not found. -
*/
public okhttp3.Call updateFieldConfigurationCall(Long id, FieldConfigurationDetails fieldConfigurationDetails, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = fieldConfigurationDetails;
// create path and map variables
String localVarPath = "/rest/api/3/fieldconfiguration/{id}"
.replace("{" + "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);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "OAuth2", "basicAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call updateFieldConfigurationValidateBeforeCall(Long id, FieldConfigurationDetails fieldConfigurationDetails, 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 updateFieldConfiguration(Async)");
}
// verify the required parameter 'fieldConfigurationDetails' is set
if (fieldConfigurationDetails == null) {
throw new ApiException("Missing the required parameter 'fieldConfigurationDetails' when calling updateFieldConfiguration(Async)");
}
return updateFieldConfigurationCall(id, fieldConfigurationDetails, _callback);
}
/**
* Update field configuration
* Updates a field configuration. The name and the description provided in the request override the existing values. This operation can only update configurations used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration. (required)
* @param fieldConfigurationDetails (required)
* @return Object
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration is not found. -
*/
public Object updateFieldConfiguration(Long id, FieldConfigurationDetails fieldConfigurationDetails) throws ApiException {
ApiResponse localVarResp = updateFieldConfigurationWithHttpInfo(id, fieldConfigurationDetails);
return localVarResp.getData();
}
/**
* Update field configuration
* Updates a field configuration. The name and the description provided in the request override the existing values. This operation can only update configurations used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration. (required)
* @param fieldConfigurationDetails (required)
* @return ApiResponse<Object>
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration is not found. -
*/
public ApiResponse updateFieldConfigurationWithHttpInfo(Long id, FieldConfigurationDetails fieldConfigurationDetails) throws ApiException {
okhttp3.Call localVarCall = updateFieldConfigurationValidateBeforeCall(id, fieldConfigurationDetails, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Update field configuration (asynchronously)
* Updates a field configuration. The name and the description provided in the request override the existing values. This operation can only update configurations used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration. (required)
* @param fieldConfigurationDetails (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 204 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration is not found. -
*/
public okhttp3.Call updateFieldConfigurationAsync(Long id, FieldConfigurationDetails fieldConfigurationDetails, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = updateFieldConfigurationValidateBeforeCall(id, fieldConfigurationDetails, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for updateFieldConfigurationItems
* @param id The ID of the field configuration. (required)
* @param fieldConfigurationItemsDetails (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 204 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration is not found. -
*/
public okhttp3.Call updateFieldConfigurationItemsCall(Long id, FieldConfigurationItemsDetails fieldConfigurationItemsDetails, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = fieldConfigurationItemsDetails;
// create path and map variables
String localVarPath = "/rest/api/3/fieldconfiguration/{id}/fields"
.replace("{" + "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);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "OAuth2", "basicAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call updateFieldConfigurationItemsValidateBeforeCall(Long id, FieldConfigurationItemsDetails fieldConfigurationItemsDetails, 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 updateFieldConfigurationItems(Async)");
}
// verify the required parameter 'fieldConfigurationItemsDetails' is set
if (fieldConfigurationItemsDetails == null) {
throw new ApiException("Missing the required parameter 'fieldConfigurationItemsDetails' when calling updateFieldConfigurationItems(Async)");
}
return updateFieldConfigurationItemsCall(id, fieldConfigurationItemsDetails, _callback);
}
/**
* Update field configuration items
* Updates fields in a field configuration. The properties of the field configuration fields provided override the existing values. This operation can only update field configurations used in company-managed (classic) projects. The operation can set the renderer for text fields to the default text renderer (`text-renderer`) or wiki style renderer (`wiki-renderer`). However, the renderer cannot be updated for fields using the autocomplete renderer (`autocomplete-renderer`). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration. (required)
* @param fieldConfigurationItemsDetails (required)
* @return Object
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration is not found. -
*/
public Object updateFieldConfigurationItems(Long id, FieldConfigurationItemsDetails fieldConfigurationItemsDetails) throws ApiException {
ApiResponse localVarResp = updateFieldConfigurationItemsWithHttpInfo(id, fieldConfigurationItemsDetails);
return localVarResp.getData();
}
/**
* Update field configuration items
* Updates fields in a field configuration. The properties of the field configuration fields provided override the existing values. This operation can only update field configurations used in company-managed (classic) projects. The operation can set the renderer for text fields to the default text renderer (`text-renderer`) or wiki style renderer (`wiki-renderer`). However, the renderer cannot be updated for fields using the autocomplete renderer (`autocomplete-renderer`). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration. (required)
* @param fieldConfigurationItemsDetails (required)
* @return ApiResponse<Object>
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration is not found. -
*/
public ApiResponse updateFieldConfigurationItemsWithHttpInfo(Long id, FieldConfigurationItemsDetails fieldConfigurationItemsDetails) throws ApiException {
okhttp3.Call localVarCall = updateFieldConfigurationItemsValidateBeforeCall(id, fieldConfigurationItemsDetails, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Update field configuration items (asynchronously)
* Updates fields in a field configuration. The properties of the field configuration fields provided override the existing values. This operation can only update field configurations used in company-managed (classic) projects. The operation can set the renderer for text fields to the default text renderer (`text-renderer`) or wiki style renderer (`wiki-renderer`). However, the renderer cannot be updated for fields using the autocomplete renderer (`autocomplete-renderer`). **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration. (required)
* @param fieldConfigurationItemsDetails (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 204 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permission. - 404 Returned if the field configuration is not found. -
*/
public okhttp3.Call updateFieldConfigurationItemsAsync(Long id, FieldConfigurationItemsDetails fieldConfigurationItemsDetails, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = updateFieldConfigurationItemsValidateBeforeCall(id, fieldConfigurationItemsDetails, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for updateFieldConfigurationScheme
* @param id The ID of the field configuration scheme. (required)
* @param updateFieldConfigurationSchemeDetails The details of the field configuration scheme. (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 204 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permissions. - 404 Returned if the field configuration scheme is not found. -
*/
public okhttp3.Call updateFieldConfigurationSchemeCall(Long id, UpdateFieldConfigurationSchemeDetails updateFieldConfigurationSchemeDetails, final ApiCallback _callback) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = updateFieldConfigurationSchemeDetails;
// create path and map variables
String localVarPath = "/rest/api/3/fieldconfigurationscheme/{id}"
.replace("{" + "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);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "OAuth2", "basicAuth" };
return localVarApiClient.buildCall(basePath, localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call updateFieldConfigurationSchemeValidateBeforeCall(Long id, UpdateFieldConfigurationSchemeDetails updateFieldConfigurationSchemeDetails, 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 updateFieldConfigurationScheme(Async)");
}
// verify the required parameter 'updateFieldConfigurationSchemeDetails' is set
if (updateFieldConfigurationSchemeDetails == null) {
throw new ApiException("Missing the required parameter 'updateFieldConfigurationSchemeDetails' when calling updateFieldConfigurationScheme(Async)");
}
return updateFieldConfigurationSchemeCall(id, updateFieldConfigurationSchemeDetails, _callback);
}
/**
* Update field configuration scheme
* Updates a field configuration scheme. This operation can only update field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration scheme. (required)
* @param updateFieldConfigurationSchemeDetails The details of the field configuration scheme. (required)
* @return Object
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permissions. - 404 Returned if the field configuration scheme is not found. -
*/
public Object updateFieldConfigurationScheme(Long id, UpdateFieldConfigurationSchemeDetails updateFieldConfigurationSchemeDetails) throws ApiException {
ApiResponse localVarResp = updateFieldConfigurationSchemeWithHttpInfo(id, updateFieldConfigurationSchemeDetails);
return localVarResp.getData();
}
/**
* Update field configuration scheme
* Updates a field configuration scheme. This operation can only update field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration scheme. (required)
* @param updateFieldConfigurationSchemeDetails The details of the field configuration scheme. (required)
* @return ApiResponse<Object>
* @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 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permissions. - 404 Returned if the field configuration scheme is not found. -
*/
public ApiResponse updateFieldConfigurationSchemeWithHttpInfo(Long id, UpdateFieldConfigurationSchemeDetails updateFieldConfigurationSchemeDetails) throws ApiException {
okhttp3.Call localVarCall = updateFieldConfigurationSchemeValidateBeforeCall(id, updateFieldConfigurationSchemeDetails, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Update field configuration scheme (asynchronously)
* Updates a field configuration scheme. This operation can only update field configuration schemes used in company-managed (classic) projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* @param id The ID of the field configuration scheme. (required)
* @param updateFieldConfigurationSchemeDetails The details of the field configuration scheme. (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 204 Returned if the request is successful. - 400 Returned if the request is not valid. - 401 Returned if the authentication credentials are incorrect or missing. - 403 Returned if the user does not have the necessary permissions. - 404 Returned if the field configuration scheme is not found. -
*/
public okhttp3.Call updateFieldConfigurationSchemeAsync(Long id, UpdateFieldConfigurationSchemeDetails updateFieldConfigurationSchemeDetails, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = updateFieldConfigurationSchemeValidateBeforeCall(id, updateFieldConfigurationSchemeDetails, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
}
