All Downloads are FREE. Search and download functionalities are using the official Maven repository.

software.tnb.jira.validation.generated.api.ScreenSchemesApi Maven / Gradle / Ivy

The newest version!
/*
 * 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.PageBeanScreenScheme;
import software.tnb.jira.validation.generated.model.ScreenSchemeDetails;
import software.tnb.jira.validation.generated.model.ScreenSchemeId;
import java.util.Set;
import software.tnb.jira.validation.generated.model.UpdateScreenSchemeDetails;

import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class ScreenSchemesApi {
    private ApiClient localVarApiClient;
    private int localHostIndex;
    private String localCustomBaseUrl;

    public ScreenSchemesApi() {
        this(Configuration.getDefaultApiClient());
    }

    public ScreenSchemesApi(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 createScreenScheme
     * @param screenSchemeDetails  (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 required permissions. -
404 Returned if a screen used as one of the screen types in the screen scheme is not found. -
*/ public okhttp3.Call createScreenSchemeCall(ScreenSchemeDetails screenSchemeDetails, 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 = screenSchemeDetails; // create path and map variables String localVarPath = "/rest/api/3/screenscheme"; 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 createScreenSchemeValidateBeforeCall(ScreenSchemeDetails screenSchemeDetails, final ApiCallback _callback) throws ApiException { // verify the required parameter 'screenSchemeDetails' is set if (screenSchemeDetails == null) { throw new ApiException("Missing the required parameter 'screenSchemeDetails' when calling createScreenScheme(Async)"); } return createScreenSchemeCall(screenSchemeDetails, _callback); } /** * Create screen scheme * Creates a screen scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * @param screenSchemeDetails (required) * @return ScreenSchemeId * @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 required permissions. -
404 Returned if a screen used as one of the screen types in the screen scheme is not found. -
*/ public ScreenSchemeId createScreenScheme(ScreenSchemeDetails screenSchemeDetails) throws ApiException { ApiResponse localVarResp = createScreenSchemeWithHttpInfo(screenSchemeDetails); return localVarResp.getData(); } /** * Create screen scheme * Creates a screen scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * @param screenSchemeDetails (required) * @return ApiResponse<ScreenSchemeId> * @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 required permissions. -
404 Returned if a screen used as one of the screen types in the screen scheme is not found. -
*/ public ApiResponse createScreenSchemeWithHttpInfo(ScreenSchemeDetails screenSchemeDetails) throws ApiException { okhttp3.Call localVarCall = createScreenSchemeValidateBeforeCall(screenSchemeDetails, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Create screen scheme (asynchronously) * Creates a screen scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * @param screenSchemeDetails (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 required permissions. -
404 Returned if a screen used as one of the screen types in the screen scheme is not found. -
*/ public okhttp3.Call createScreenSchemeAsync(ScreenSchemeDetails screenSchemeDetails, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = createScreenSchemeValidateBeforeCall(screenSchemeDetails, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for deleteScreenScheme * @param screenSchemeId The ID of the screen 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 screen scheme is deleted. -
400 Returned if the screen scheme is used in an issue type screen scheme. -
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 screen scheme is not found. -
*/ public okhttp3.Call deleteScreenSchemeCall(String screenSchemeId, 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/screenscheme/{screenSchemeId}" .replace("{" + "screenSchemeId" + "}", localVarApiClient.escapeString(screenSchemeId.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 deleteScreenSchemeValidateBeforeCall(String screenSchemeId, final ApiCallback _callback) throws ApiException { // verify the required parameter 'screenSchemeId' is set if (screenSchemeId == null) { throw new ApiException("Missing the required parameter 'screenSchemeId' when calling deleteScreenScheme(Async)"); } return deleteScreenSchemeCall(screenSchemeId, _callback); } /** * Delete screen scheme * Deletes a screen scheme. A screen scheme cannot be deleted if it is used in an issue type screen scheme. Only screens schemes used in classic projects can be deleted. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * @param screenSchemeId The ID of the screen scheme. (required) * @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 screen scheme is deleted. -
400 Returned if the screen scheme is used in an issue type screen scheme. -
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 screen scheme is not found. -
*/ public void deleteScreenScheme(String screenSchemeId) throws ApiException { deleteScreenSchemeWithHttpInfo(screenSchemeId); } /** * Delete screen scheme * Deletes a screen scheme. A screen scheme cannot be deleted if it is used in an issue type screen scheme. Only screens schemes used in classic projects can be deleted. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * @param screenSchemeId The ID of the screen scheme. (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details
Status Code Description Response Headers
204 Returned if the screen scheme is deleted. -
400 Returned if the screen scheme is used in an issue type screen scheme. -
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 screen scheme is not found. -
*/ public ApiResponse deleteScreenSchemeWithHttpInfo(String screenSchemeId) throws ApiException { okhttp3.Call localVarCall = deleteScreenSchemeValidateBeforeCall(screenSchemeId, null); return localVarApiClient.execute(localVarCall); } /** * Delete screen scheme (asynchronously) * Deletes a screen scheme. A screen scheme cannot be deleted if it is used in an issue type screen scheme. Only screens schemes used in classic projects can be deleted. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * @param screenSchemeId The ID of the screen 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 screen scheme is deleted. -
400 Returned if the screen scheme is used in an issue type screen scheme. -
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 screen scheme is not found. -
*/ public okhttp3.Call deleteScreenSchemeAsync(String screenSchemeId, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = deleteScreenSchemeValidateBeforeCall(screenSchemeId, _callback); localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } /** * Build call for getScreenSchemes * @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 25) * @param id The list of screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. (optional) * @param expand Use [expand](#expansion) include additional information in the response. This parameter accepts `issueTypeScreenSchemes` that, for each screen schemes, returns information about the issue type screen scheme the screen scheme is assigned to. (optional, default to ) * @param queryString String used to perform a case-insensitive partial match with screen scheme name. (optional, default to ) * @param orderBy [Order](#ordering) the results by a field: * `id` Sorts by screen scheme ID. * `name` Sorts by screen scheme name. (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. -
401 Returned if the authentication credentials are incorrect or missing. -
403 Returned if the user does not have the necessary permission. -
*/ public okhttp3.Call getScreenSchemesCall(Long startAt, Integer maxResults, Set id, String expand, String queryString, String orderBy, 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/screenscheme"; 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 (expand != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("expand", expand)); } if (queryString != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("queryString", queryString)); } if (orderBy != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("orderBy", orderBy)); } 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 getScreenSchemesValidateBeforeCall(Long startAt, Integer maxResults, Set id, String expand, String queryString, String orderBy, final ApiCallback _callback) throws ApiException { return getScreenSchemesCall(startAt, maxResults, id, expand, queryString, orderBy, _callback); } /** * Get screen schemes * Returns a [paginated](#pagination) list of screen schemes. Only screen 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 25) * @param id The list of screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. (optional) * @param expand Use [expand](#expansion) include additional information in the response. This parameter accepts `issueTypeScreenSchemes` that, for each screen schemes, returns information about the issue type screen scheme the screen scheme is assigned to. (optional, default to ) * @param queryString String used to perform a case-insensitive partial match with screen scheme name. (optional, default to ) * @param orderBy [Order](#ordering) the results by a field: * `id` Sorts by screen scheme ID. * `name` Sorts by screen scheme name. (optional) * @return PageBeanScreenScheme * @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 PageBeanScreenScheme getScreenSchemes(Long startAt, Integer maxResults, Set id, String expand, String queryString, String orderBy) throws ApiException { ApiResponse localVarResp = getScreenSchemesWithHttpInfo(startAt, maxResults, id, expand, queryString, orderBy); return localVarResp.getData(); } /** * Get screen schemes * Returns a [paginated](#pagination) list of screen schemes. Only screen 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 25) * @param id The list of screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. (optional) * @param expand Use [expand](#expansion) include additional information in the response. This parameter accepts `issueTypeScreenSchemes` that, for each screen schemes, returns information about the issue type screen scheme the screen scheme is assigned to. (optional, default to ) * @param queryString String used to perform a case-insensitive partial match with screen scheme name. (optional, default to ) * @param orderBy [Order](#ordering) the results by a field: * `id` Sorts by screen scheme ID. * `name` Sorts by screen scheme name. (optional) * @return ApiResponse<PageBeanScreenScheme> * @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 getScreenSchemesWithHttpInfo(Long startAt, Integer maxResults, Set id, String expand, String queryString, String orderBy) throws ApiException { okhttp3.Call localVarCall = getScreenSchemesValidateBeforeCall(startAt, maxResults, id, expand, queryString, orderBy, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get screen schemes (asynchronously) * Returns a [paginated](#pagination) list of screen schemes. Only screen 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 25) * @param id The list of screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. (optional) * @param expand Use [expand](#expansion) include additional information in the response. This parameter accepts `issueTypeScreenSchemes` that, for each screen schemes, returns information about the issue type screen scheme the screen scheme is assigned to. (optional, default to ) * @param queryString String used to perform a case-insensitive partial match with screen scheme name. (optional, default to ) * @param orderBy [Order](#ordering) the results by a field: * `id` Sorts by screen scheme ID. * `name` Sorts by screen scheme name. (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. -
401 Returned if the authentication credentials are incorrect or missing. -
403 Returned if the user does not have the necessary permission. -
*/ public okhttp3.Call getScreenSchemesAsync(Long startAt, Integer maxResults, Set id, String expand, String queryString, String orderBy, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getScreenSchemesValidateBeforeCall(startAt, maxResults, id, expand, queryString, orderBy, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for updateScreenScheme * @param screenSchemeId The ID of the screen scheme. (required) * @param updateScreenSchemeDetails The screen scheme update details. (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 required permissions. -
404 Returned if the screen scheme or a screen used as one of the screen types is not found. -
*/ public okhttp3.Call updateScreenSchemeCall(String screenSchemeId, UpdateScreenSchemeDetails updateScreenSchemeDetails, 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 = updateScreenSchemeDetails; // create path and map variables String localVarPath = "/rest/api/3/screenscheme/{screenSchemeId}" .replace("{" + "screenSchemeId" + "}", localVarApiClient.escapeString(screenSchemeId.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 updateScreenSchemeValidateBeforeCall(String screenSchemeId, UpdateScreenSchemeDetails updateScreenSchemeDetails, final ApiCallback _callback) throws ApiException { // verify the required parameter 'screenSchemeId' is set if (screenSchemeId == null) { throw new ApiException("Missing the required parameter 'screenSchemeId' when calling updateScreenScheme(Async)"); } // verify the required parameter 'updateScreenSchemeDetails' is set if (updateScreenSchemeDetails == null) { throw new ApiException("Missing the required parameter 'updateScreenSchemeDetails' when calling updateScreenScheme(Async)"); } return updateScreenSchemeCall(screenSchemeId, updateScreenSchemeDetails, _callback); } /** * Update screen scheme * Updates a screen scheme. Only screen schemes used in classic projects can be updated. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * @param screenSchemeId The ID of the screen scheme. (required) * @param updateScreenSchemeDetails The screen scheme update details. (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 required permissions. -
404 Returned if the screen scheme or a screen used as one of the screen types is not found. -
*/ public Object updateScreenScheme(String screenSchemeId, UpdateScreenSchemeDetails updateScreenSchemeDetails) throws ApiException { ApiResponse localVarResp = updateScreenSchemeWithHttpInfo(screenSchemeId, updateScreenSchemeDetails); return localVarResp.getData(); } /** * Update screen scheme * Updates a screen scheme. Only screen schemes used in classic projects can be updated. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * @param screenSchemeId The ID of the screen scheme. (required) * @param updateScreenSchemeDetails The screen scheme update details. (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 required permissions. -
404 Returned if the screen scheme or a screen used as one of the screen types is not found. -
*/ public ApiResponse updateScreenSchemeWithHttpInfo(String screenSchemeId, UpdateScreenSchemeDetails updateScreenSchemeDetails) throws ApiException { okhttp3.Call localVarCall = updateScreenSchemeValidateBeforeCall(screenSchemeId, updateScreenSchemeDetails, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Update screen scheme (asynchronously) * Updates a screen scheme. Only screen schemes used in classic projects can be updated. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * @param screenSchemeId The ID of the screen scheme. (required) * @param updateScreenSchemeDetails The screen scheme update details. (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 required permissions. -
404 Returned if the screen scheme or a screen used as one of the screen types is not found. -
*/ public okhttp3.Call updateScreenSchemeAsync(String screenSchemeId, UpdateScreenSchemeDetails updateScreenSchemeDetails, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = updateScreenSchemeValidateBeforeCall(screenSchemeId, updateScreenSchemeDetails, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } }