Package com.configcat.publicapi.java.client.api

Class FeatureFlagSettingValuesV2Api

  • public class FeatureFlagSettingValuesV2Api
extends java.lang.Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ApiClient getApiClient()  
      java.lang.String getCustomBaseUrl()  
      int getHostIndex()  
      ConfigSettingFormulasModel getSettingValuesV2​(java.util.UUID configId, java.util.UUID environmentId)
      Get values This endpoint returns all Feature Flag and Setting values of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter.
      okhttp3.Call getSettingValuesV2Async​(java.util.UUID configId, java.util.UUID environmentId, ApiCallback<ConfigSettingFormulasModel> _callback)
      Get values (asynchronously) This endpoint returns all Feature Flag and Setting values of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter.
      okhttp3.Call getSettingValuesV2Call​(java.util.UUID configId, java.util.UUID environmentId, ApiCallback _callback)
      Build call for getSettingValuesV2
      ApiResponse<ConfigSettingFormulasModel> getSettingValuesV2WithHttpInfo​(java.util.UUID configId, java.util.UUID environmentId)
      Get values This endpoint returns all Feature Flag and Setting values of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter.
      SettingFormulaModel getSettingValueV2​(java.util.UUID environmentId, java.lang.Integer settingId)
      Get value This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter.
      okhttp3.Call getSettingValueV2Async​(java.util.UUID environmentId, java.lang.Integer settingId, ApiCallback<SettingFormulaModel> _callback)
      Get value (asynchronously) This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter.
      okhttp3.Call getSettingValueV2Call​(java.util.UUID environmentId, java.lang.Integer settingId, ApiCallback _callback)
      Build call for getSettingValueV2
      ApiResponse<SettingFormulaModel> getSettingValueV2WithHttpInfo​(java.util.UUID environmentId, java.lang.Integer settingId)
      Get value This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter.
      ConfigSettingFormulasModel postSettingValuesV2​(java.util.UUID configId, java.util.UUID environmentId, UpdateEvaluationFormulasModel updateEvaluationFormulasModel, java.lang.String reason)
      Post values This endpoint batch updates the Feature Flags and Settings of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter.
      okhttp3.Call postSettingValuesV2Async​(java.util.UUID configId, java.util.UUID environmentId, UpdateEvaluationFormulasModel updateEvaluationFormulasModel, java.lang.String reason, ApiCallback<ConfigSettingFormulasModel> _callback)
      Post values (asynchronously) This endpoint batch updates the Feature Flags and Settings of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter.
      okhttp3.Call postSettingValuesV2Call​(java.util.UUID configId, java.util.UUID environmentId, UpdateEvaluationFormulasModel updateEvaluationFormulasModel, java.lang.String reason, ApiCallback _callback)
      Build call for postSettingValuesV2
      ApiResponse<ConfigSettingFormulasModel> postSettingValuesV2WithHttpInfo​(java.util.UUID configId, java.util.UUID environmentId, UpdateEvaluationFormulasModel updateEvaluationFormulasModel, java.lang.String reason)
      Post values This endpoint batch updates the Feature Flags and Settings of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter.
      SettingFormulaModel replaceSettingValueV2​(java.util.UUID environmentId, java.lang.Integer settingId, UpdateEvaluationFormulaModel updateEvaluationFormulaModel, java.lang.String reason)
      Replace value This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://app.configcat.com/sdkkey\">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header.
      okhttp3.Call replaceSettingValueV2Async​(java.util.UUID environmentId, java.lang.Integer settingId, UpdateEvaluationFormulaModel updateEvaluationFormulaModel, java.lang.String reason, ApiCallback<SettingFormulaModel> _callback)
      Replace value (asynchronously) This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://app.configcat.com/sdkkey\">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header.
      okhttp3.Call replaceSettingValueV2Call​(java.util.UUID environmentId, java.lang.Integer settingId, UpdateEvaluationFormulaModel updateEvaluationFormulaModel, java.lang.String reason, ApiCallback _callback)
      Build call for replaceSettingValueV2
      ApiResponse<SettingFormulaModel> replaceSettingValueV2WithHttpInfo​(java.util.UUID environmentId, java.lang.Integer settingId, UpdateEvaluationFormulaModel updateEvaluationFormulaModel, java.lang.String reason)
      Replace value This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://app.configcat.com/sdkkey\">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header.
      void setApiClient​(ApiClient apiClient)  
      void setCustomBaseUrl​(java.lang.String customBaseUrl)  
      void setHostIndex​(int hostIndex)  
      SettingFormulaModel updateSettingValueV2​(java.util.UUID environmentId, java.lang.Integer settingId, java.util.List<JsonPatchOperation> jsonPatchOperation, java.lang.String reason)
      Update value This endpoint updates the value of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Environment.
      okhttp3.Call updateSettingValueV2Async​(java.util.UUID environmentId, java.lang.Integer settingId, java.util.List<JsonPatchOperation> jsonPatchOperation, java.lang.String reason, ApiCallback<SettingFormulaModel> _callback)
      Update value (asynchronously) This endpoint updates the value of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Environment.
      okhttp3.Call updateSettingValueV2Call​(java.util.UUID environmentId, java.lang.Integer settingId, java.util.List<JsonPatchOperation> jsonPatchOperation, java.lang.String reason, ApiCallback _callback)
      Build call for updateSettingValueV2
      ApiResponse<SettingFormulaModel> updateSettingValueV2WithHttpInfo​(java.util.UUID environmentId, java.lang.Integer settingId, java.util.List<JsonPatchOperation> jsonPatchOperation, java.lang.String reason)
      Update value This endpoint updates the value of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Environment.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • FeatureFlagSettingValuesV2Api

        public FeatureFlagSettingValuesV2Api()

      • FeatureFlagSettingValuesV2Api

        public FeatureFlagSettingValuesV2Api​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • getHostIndex

        public int getHostIndex()

      • setHostIndex

        public void setHostIndex​(int hostIndex)

      • getCustomBaseUrl

        public java.lang.String getCustomBaseUrl()

      • setCustomBaseUrl

        public void setCustomBaseUrl​(java.lang.String customBaseUrl)

      • getSettingValueV2Call

        public okhttp3.Call getSettingValueV2Call​(java.util.UUID environmentId,
                                          java.lang.Integer settingId,
                                          ApiCallback _callback)
                                   throws ApiException
        Build call for getSettingValueV2
        Parameters:
        environmentId - The identifier of the Environment. (required)
        settingId - The id of the Setting. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details
        Status Code Description Response Headers
        200 When everything is ok, the setting value data returned. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • getSettingValueV2

        public SettingFormulaModel getSettingValueV2​(java.util.UUID environmentId,
                                             java.lang.Integer settingId)
                                      throws ApiException
        Get value This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/targeting/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/targeting/percentage-options/) of the Feature Flag or Setting.
        Parameters:
        environmentId - The identifier of the Environment. (required)
        settingId - The id of the Setting. (required)
        Returns:
        SettingFormulaModel
        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 When everything is ok, the setting value data returned. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • getSettingValueV2WithHttpInfo

        public ApiResponse<SettingFormulaModel> getSettingValueV2WithHttpInfo​(java.util.UUID environmentId,
                                                                      java.lang.Integer settingId)
                                                               throws ApiException
        Get value This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/targeting/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/targeting/percentage-options/) of the Feature Flag or Setting.
        Parameters:
        environmentId - The identifier of the Environment. (required)
        settingId - The id of the Setting. (required)
        Returns:
        ApiResponse<SettingFormulaModel>
        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 When everything is ok, the setting value data returned. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • getSettingValueV2Async

        public okhttp3.Call getSettingValueV2Async​(java.util.UUID environmentId,
                                           java.lang.Integer settingId,
                                           ApiCallback<SettingFormulaModel> _callback)
                                    throws ApiException
        Get value (asynchronously) This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/targeting/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/targeting/percentage-options/) of the Feature Flag or Setting.
        Parameters:
        environmentId - The identifier of the Environment. (required)
        settingId - The id of the Setting. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        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 When everything is ok, the setting value data returned. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • getSettingValuesV2Call

        public okhttp3.Call getSettingValuesV2Call​(java.util.UUID configId,
                                           java.util.UUID environmentId,
                                           ApiCallback _callback)
                                    throws ApiException
        Build call for getSettingValuesV2
        Parameters:
        configId - The identifier of the Config. (required)
        environmentId - The identifier of the Environment. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details
        Status Code Description Response Headers
        200 When everything is ok, the setting values returned. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • getSettingValuesV2

        public ConfigSettingFormulasModel getSettingValuesV2​(java.util.UUID configId,
                                                     java.util.UUID environmentId)
                                              throws ApiException
        Get values This endpoint returns all Feature Flag and Setting values of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/targeting/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/targeting/percentage-options/) of the Feature Flag or Setting.
        Parameters:
        configId - The identifier of the Config. (required)
        environmentId - The identifier of the Environment. (required)
        Returns:
        ConfigSettingFormulasModel
        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 When everything is ok, the setting values returned. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • getSettingValuesV2WithHttpInfo

        public ApiResponse<ConfigSettingFormulasModel> getSettingValuesV2WithHttpInfo​(java.util.UUID configId,
                                                                              java.util.UUID environmentId)
                                                                       throws ApiException
        Get values This endpoint returns all Feature Flag and Setting values of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/targeting/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/targeting/percentage-options/) of the Feature Flag or Setting.
        Parameters:
        configId - The identifier of the Config. (required)
        environmentId - The identifier of the Environment. (required)
        Returns:
        ApiResponse<ConfigSettingFormulasModel>
        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 When everything is ok, the setting values returned. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • getSettingValuesV2Async

        public okhttp3.Call getSettingValuesV2Async​(java.util.UUID configId,
                                            java.util.UUID environmentId,
                                            ApiCallback<ConfigSettingFormulasModel> _callback)
                                     throws ApiException
        Get values (asynchronously) This endpoint returns all Feature Flag and Setting values of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/targeting/user-object/) attribute that must be used for [percentage evaluation](https://configcat.com/docs/targeting/percentage-options/) of the Feature Flag or Setting.
        Parameters:
        configId - The identifier of the Config. (required)
        environmentId - The identifier of the Environment. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        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 When everything is ok, the setting values returned. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • postSettingValuesV2Call

        public okhttp3.Call postSettingValuesV2Call​(java.util.UUID configId,
                                            java.util.UUID environmentId,
                                            UpdateEvaluationFormulasModel updateEvaluationFormulasModel,
                                            java.lang.String reason,
                                            ApiCallback _callback)
                                     throws ApiException
        Build call for postSettingValuesV2
        Parameters:
        configId - The identifier of the Config. (required)
        environmentId - The identifier of the Environment. (required)
        updateEvaluationFormulasModel - (required)
        reason - The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details
        Status Code Description Response Headers
        200 When everything is ok, the updated setting values returned. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • postSettingValuesV2

        public ConfigSettingFormulasModel postSettingValuesV2​(java.util.UUID configId,
                                                      java.util.UUID environmentId,
                                                      UpdateEvaluationFormulasModel updateEvaluationFormulasModel,
                                                      java.lang.String reason)
                                               throws ApiException
        Post values This endpoint batch updates the Feature Flags and Settings of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only those Feature Flags and Settings are updated which are part of the request, all the others are left untouched. **Important:** As this endpoint is doing a complete replace on those Feature Flags and Settings, which are set in the request. It's important to set every other field that you don't want to change in its original state. Not listing a field means that it will reset. For example: We have the following resource of a Feature Flag. ```json { \"settingFormulas\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ], \"settingId\": 1 } ] } ``` If we send a batch replace request body as below: ```json { \"updateFormulas\": [ { \"defaultValue\": { \"boolValue\": false }, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all Targeting Rules of the related Feature Flag are deleted. So we get a response like this: ```json { \"settingFormulas\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [], \"setting\": { \"settingId\": 1 } } ] } ```
        Parameters:
        configId - The identifier of the Config. (required)
        environmentId - The identifier of the Environment. (required)
        updateEvaluationFormulasModel - (required)
        reason - The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)
        Returns:
        ConfigSettingFormulasModel
        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 When everything is ok, the updated setting values returned. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • postSettingValuesV2WithHttpInfo

        public ApiResponse<ConfigSettingFormulasModel> postSettingValuesV2WithHttpInfo​(java.util.UUID configId,
                                                                               java.util.UUID environmentId,
                                                                               UpdateEvaluationFormulasModel updateEvaluationFormulasModel,
                                                                               java.lang.String reason)
                                                                        throws ApiException
        Post values This endpoint batch updates the Feature Flags and Settings of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only those Feature Flags and Settings are updated which are part of the request, all the others are left untouched. **Important:** As this endpoint is doing a complete replace on those Feature Flags and Settings, which are set in the request. It's important to set every other field that you don't want to change in its original state. Not listing a field means that it will reset. For example: We have the following resource of a Feature Flag. ```json { \"settingFormulas\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ], \"settingId\": 1 } ] } ``` If we send a batch replace request body as below: ```json { \"updateFormulas\": [ { \"defaultValue\": { \"boolValue\": false }, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all Targeting Rules of the related Feature Flag are deleted. So we get a response like this: ```json { \"settingFormulas\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [], \"setting\": { \"settingId\": 1 } } ] } ```
        Parameters:
        configId - The identifier of the Config. (required)
        environmentId - The identifier of the Environment. (required)
        updateEvaluationFormulasModel - (required)
        reason - The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)
        Returns:
        ApiResponse<ConfigSettingFormulasModel>
        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 When everything is ok, the updated setting values returned. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • postSettingValuesV2Async

        public okhttp3.Call postSettingValuesV2Async​(java.util.UUID configId,
                                             java.util.UUID environmentId,
                                             UpdateEvaluationFormulasModel updateEvaluationFormulasModel,
                                             java.lang.String reason,
                                             ApiCallback<ConfigSettingFormulasModel> _callback)
                                      throws ApiException
        Post values (asynchronously) This endpoint batch updates the Feature Flags and Settings of a Config identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. Only those Feature Flags and Settings are updated which are part of the request, all the others are left untouched. **Important:** As this endpoint is doing a complete replace on those Feature Flags and Settings, which are set in the request. It's important to set every other field that you don't want to change in its original state. Not listing a field means that it will reset. For example: We have the following resource of a Feature Flag. ```json { \"settingFormulas\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ], \"settingId\": 1 } ] } ``` If we send a batch replace request body as below: ```json { \"updateFormulas\": [ { \"defaultValue\": { \"boolValue\": false }, \"settingId\": 1 } ] } ``` Then besides that the default value is set to `true`, all Targeting Rules of the related Feature Flag are deleted. So we get a response like this: ```json { \"settingFormulas\": [ { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [], \"setting\": { \"settingId\": 1 } } ] } ```
        Parameters:
        configId - The identifier of the Config. (required)
        environmentId - The identifier of the Environment. (required)
        updateEvaluationFormulasModel - (required)
        reason - The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        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 When everything is ok, the updated setting values returned. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • replaceSettingValueV2Call

        public okhttp3.Call replaceSettingValueV2Call​(java.util.UUID environmentId,
                                              java.lang.Integer settingId,
                                              UpdateEvaluationFormulaModel updateEvaluationFormulaModel,
                                              java.lang.String reason,
                                              ApiCallback _callback)
                                       throws ApiException
        Build call for replaceSettingValueV2
        Parameters:
        environmentId - The identifier of the Environment. (required)
        settingId - The id of the Setting. (required)
        updateEvaluationFormulaModel - (required)
        reason - The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details
        Status Code Description Response Headers
        200 -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • replaceSettingValueV2

        public SettingFormulaModel replaceSettingValueV2​(java.util.UUID environmentId,
                                                 java.lang.Integer settingId,
                                                 UpdateEvaluationFormulaModel updateEvaluationFormulaModel,
                                                 java.lang.String reason)
                                          throws ApiException
        Replace value This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://app.configcat.com/sdkkey\">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it's important to set every other field that you don't want to change to its original state. Not listing one means it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ```
        Parameters:
        environmentId - The identifier of the Environment. (required)
        settingId - The id of the Setting. (required)
        updateEvaluationFormulaModel - (required)
        reason - The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)
        Returns:
        SettingFormulaModel
        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 -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • replaceSettingValueV2WithHttpInfo

        public ApiResponse<SettingFormulaModel> replaceSettingValueV2WithHttpInfo​(java.util.UUID environmentId,
                                                                          java.lang.Integer settingId,
                                                                          UpdateEvaluationFormulaModel updateEvaluationFormulaModel,
                                                                          java.lang.String reason)
                                                                   throws ApiException
        Replace value This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://app.configcat.com/sdkkey\">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it's important to set every other field that you don't want to change to its original state. Not listing one means it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ```
        Parameters:
        environmentId - The identifier of the Environment. (required)
        settingId - The id of the Setting. (required)
        updateEvaluationFormulaModel - (required)
        reason - The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)
        Returns:
        ApiResponse<SettingFormulaModel>
        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 -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • replaceSettingValueV2Async

        public okhttp3.Call replaceSettingValueV2Async​(java.util.UUID environmentId,
                                               java.lang.Integer settingId,
                                               UpdateEvaluationFormulaModel updateEvaluationFormulaModel,
                                               java.lang.String reason,
                                               ApiCallback<SettingFormulaModel> _callback)
                                        throws ApiException
        Replace value (asynchronously) This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://app.configcat.com/sdkkey\">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it's important to set every other field that you don't want to change to its original state. Not listing one means it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ```
        Parameters:
        environmentId - The identifier of the Environment. (required)
        settingId - The id of the Setting. (required)
        updateEvaluationFormulaModel - (required)
        reason - The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        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 -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • updateSettingValueV2Call

        public okhttp3.Call updateSettingValueV2Call​(java.util.UUID environmentId,
                                             java.lang.Integer settingId,
                                             java.util.List<JsonPatchOperation> jsonPatchOperation,
                                             java.lang.String reason,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for updateSettingValueV2
        Parameters:
        environmentId - The identifier of the Environment. (required)
        settingId - The id of the Setting. (required)
        jsonPatchOperation - (required)
        reason - The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details
        Status Code Description Response Headers
        200 When the patch was successful. -
        204 When no change applied on the resource. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • updateSettingValueV2

        public SettingFormulaModel updateSettingValueV2​(java.util.UUID environmentId,
                                                java.lang.Integer settingId,
                                                java.util.List<JsonPatchOperation> jsonPatchOperation,
                                                java.lang.String reason)
                                         throws ApiException
        Update value This endpoint updates the value of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Environment. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change. It supports collection reordering, so it also can be used for reordering the targeting rules of a Feature Flag or Setting. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send an update request body as below: ```json [ { \"op\": \"replace\", \"path\": \"/targetingRules/0/value/boolValue\", \"value\": true } ] ``` Only the first Targeting Rule's `value` is going to be set to `false` and all the other fields are remaining unchanged. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": false } } ] } ```
        Parameters:
        environmentId - The identifier of the Environment. (required)
        settingId - The id of the Setting. (required)
        jsonPatchOperation - (required)
        reason - The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)
        Returns:
        SettingFormulaModel
        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 When the patch was successful. -
        204 When no change applied on the resource. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • updateSettingValueV2WithHttpInfo

        public ApiResponse<SettingFormulaModel> updateSettingValueV2WithHttpInfo​(java.util.UUID environmentId,
                                                                         java.lang.Integer settingId,
                                                                         java.util.List<JsonPatchOperation> jsonPatchOperation,
                                                                         java.lang.String reason)
                                                                  throws ApiException
        Update value This endpoint updates the value of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Environment. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change. It supports collection reordering, so it also can be used for reordering the targeting rules of a Feature Flag or Setting. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send an update request body as below: ```json [ { \"op\": \"replace\", \"path\": \"/targetingRules/0/value/boolValue\", \"value\": true } ] ``` Only the first Targeting Rule's `value` is going to be set to `false` and all the other fields are remaining unchanged. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": false } } ] } ```
        Parameters:
        environmentId - The identifier of the Environment. (required)
        settingId - The id of the Setting. (required)
        jsonPatchOperation - (required)
        reason - The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)
        Returns:
        ApiResponse<SettingFormulaModel>
        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 When the patch was successful. -
        204 When no change applied on the resource. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • updateSettingValueV2Async

        public okhttp3.Call updateSettingValueV2Async​(java.util.UUID environmentId,
                                              java.lang.Integer settingId,
                                              java.util.List<JsonPatchOperation> jsonPatchOperation,
                                              java.lang.String reason,
                                              ApiCallback<SettingFormulaModel> _callback)
                                       throws ApiException
        Update value (asynchronously) This endpoint updates the value of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Environment. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change. It supports collection reordering, so it also can be used for reordering the targeting rules of a Feature Flag or Setting. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send an update request body as below: ```json [ { \"op\": \"replace\", \"path\": \"/targetingRules/0/value/boolValue\", \"value\": true } ] ``` Only the first Targeting Rule's `value` is going to be set to `false` and all the other fields are remaining unchanged. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": false } } ] } ```
        Parameters:
        environmentId - The identifier of the Environment. (required)
        settingId - The id of the Setting. (required)
        jsonPatchOperation - (required)
        reason - The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        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 When the patch was successful. -
        204 When no change applied on the resource. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -